Skip to main content
POST
/
autoramps
/
{autoramp_id}
/
payments
/
open-banking
Create an open banking payment link
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>"
}
'
{
  "id": "<string>",
  "iron_payment_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "payment_link": "<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

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

Example:
{
  "amount": "100.5",
  "currency": { "code": "USD", "type": "Fiat" }
}
​
callback_url
string
required

Response

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