Create an open banking payment link

Create an open banking payment link for a given autoramp

POST /autoramps/{autoramp_id}/payments/open-banking

Create an open banking payment link

cURL

curl --request POST \
  --url https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}/payments/open-banking \
  --header 'Content-Type: application/json; charset=utf-8' \
  --header 'IDEMPOTENCY-KEY: <idempotency-key>' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "amount_in": {
    "amount": "100.5",
    "currency": {
      "code": "USD",
      "type": "Fiat"
    }
  },
  "callback_url": "<string>"
}
'

import requests

url = "https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}/payments/open-banking"

payload = {
    "amount_in": {
        "amount": "100.5",
        "currency": {
            "code": "USD",
            "type": "Fiat"
        }
    },
    "callback_url": "<string>"
}
headers = {
    "IDEMPOTENCY-KEY": "<idempotency-key>",
    "X-API-Key": "<api-key>",
    "Content-Type": "application/json; charset=utf-8"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'IDEMPOTENCY-KEY': '<idempotency-key>',
    'X-API-Key': '<api-key>',
    'Content-Type': 'application/json; charset=utf-8'
  },
  body: JSON.stringify({
    amount_in: {amount: '100.5', currency: {code: 'USD', type: 'Fiat'}},
    callback_url: '<string>'
  })
};

fetch('https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}/payments/open-banking', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}/payments/open-banking",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount_in' => [
        'amount' => '100.5',
        'currency' => [
                'code' => 'USD',
                'type' => 'Fiat'
        ]
    ],
    'callback_url' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json; charset=utf-8",
    "IDEMPOTENCY-KEY: <idempotency-key>",
    "X-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}/payments/open-banking"

	payload := strings.NewReader("{\n  \"amount_in\": {\n    \"amount\": \"100.5\",\n    \"currency\": {\n      \"code\": \"USD\",\n      \"type\": \"Fiat\"\n    }\n  },\n  \"callback_url\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("IDEMPOTENCY-KEY", "<idempotency-key>")
	req.Header.Add("X-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json; charset=utf-8")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}/payments/open-banking")
  .header("IDEMPOTENCY-KEY", "<idempotency-key>")
  .header("X-API-Key", "<api-key>")
  .header("Content-Type", "application/json; charset=utf-8")
  .body("{\n  \"amount_in\": {\n    \"amount\": \"100.5\",\n    \"currency\": {\n      \"code\": \"USD\",\n      \"type\": \"Fiat\"\n    }\n  },\n  \"callback_url\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.sandbox.iron.xyz/api/autoramps/{autoramp_id}/payments/open-banking")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["IDEMPOTENCY-KEY"] = '<idempotency-key>'
request["X-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json; charset=utf-8'
request.body = "{\n  \"amount_in\": {\n    \"amount\": \"100.5\",\n    \"currency\": {\n      \"code\": \"USD\",\n      \"type\": \"Fiat\"\n    }\n  },\n  \"callback_url\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

201

{
  "id": "<string>",
  "iron_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payment_link": "<string>"
}

"<string>"

"<string>"

"<string>"

{
  "message": "<string>",
  "trace_id": "<string>"
}

Authorizations

X-API-Key · string · header · required

API Key

Headers

IDEMPOTENCY-KEY · string · required

a UUID ensuring an Autoramp operation is only processed once

X-API-Version · string

Selects the API version for this request, as an ISO date (YYYY-MM-DD). Omit to use the default version (2025-03-13). Supported versions: 2025-03-13, 2026-07-01.

Path Parameters

autoramp_id · string<uuid> · required

The autoramp ID

Body

application/json; charset=utf-8

Open banking payment parameters

Create Autoramp Payment Link Payload

The parameters for creating an autoramp payment link

amount_in · Amount · object · required

An amount of money

Show child attributes

Example:

{
  "amount": "100.5",
  "currency": { "code": "USD", "type": "Fiat" }
}

callback_url · string · required

Response

201

application/json; charset=utf-8

Create autoramp successful

Autoramp Open Banking Payment with link to initiate flow

One payment attempt against a provider for an autoramp's open-banking flow.

id · string · required

The provider's payment ID (e.g. tokenio's payment ID). Use this with the GET-by-id endpoint to look up the latest status.

iron_payment_id · string<uuid> · required

Iron's internal identifier for this open banking payment. Use this as the pagination cursor when listing payments.

status · enum<string> · required

Autoramp Payment Link Status

The status of the autoramp payment link

Available options: Pending, Ready, Processing, Completed, Failed

payment_link · string

settlement_status · enum<string>

Available options: InProgress, Completed, Incomplete