Origins and destinations

Payment origins represent the sources from which funds are pulled to initiate a payment.

These can include bank accounts, cards, wallets, or other funding mechanisms linked to a user or organization. Every payment or payment attempt includes one or more origins that define where the money comes from.

Use the Payment Origins API to list all available origins associated with a payment flow.

Payment destinations represent where the funds are intended to go during a payment.

Destinations can include user accounts, external bank accounts, wallets, or third-party providers. Every payment or payment attempt includes one or more destinations that specify where the money should be delivered.

Use the Payment Destinations API to list all destinations defined in a payment flow.

Go to origins and destinations page for more information.

Each origin and destination must include a type field that defines how the funds move. Go to Payment node page for more information.

Endpoints
GET /payment-origins
GET /payment-destinations

The payment-node object

Attributes
all ofOptional
and
one ofOptional
or
or
or
or
or
or
or

The payment-node object

{
  "externalId": "text",
  "name": "text",
  "type": "PAYMENT_LINK",
  "amount": "text",
  "currency": "text",
  "settlement": "text",
  "fee": {
    "name": "text",
    "type": "FIXED",
    "value": "text",
    "amount": "text",
    "currency": "text"
  },
  "identity": {},
  "metadata": {
    "image": "text",
    "description": "text",
    "category": "text"
  },
  "amountOut": "text",
  "card": {
    "holder": "text",
    "scheme": "text",
    "type": "text",
    "mask": "text",
    "country": "text",
    "tokenized": "text"
  }
}

Node types

Get payment-origins

get
Authorizations
Query parameters
accountNumberstringOptional

corresponding accountNumber

Example: 679c482ee4420cb5b0966c9a
Header parameters
x-api-keystringRequired

The API key used for authentication when making requests to the API Gateway.

User-AgentstringRequired

Identifies the application making the request.

Responses
200Success
application/json
get
GET /payment-origins HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Accept: */*

[
  {
    "name": "text",
    "type": "PAYMENT_LINK",
    "currency": "text",
    "settlement": "text",
    "fee": {
      "name": "text",
      "type": "FIXED",
      "value": "text",
      "amount": "text",
      "currency": "text"
    },
    "metadata": {
      "image": "text",
      "description": "text",
      "category": "text"
    },
    "card": {
      "holder": "text",
      "scheme": "text",
      "type": "text",
      "mask": "text",
      "country": "text",
      "tokenized": "text",
      "minimumAmount": "text",
      "maximumAmount": "text"
    }
  }
]

Get payment-destinations

get
Authorizations
Query parameters
accountNumberstringOptional

corresponding accountNumber

Example: 679c482ee4420cb5b0966c9a
typestringOptional

type of destination

Example: BANK_ACCOUNT
Header parameters
x-api-keystringRequired

The API key used for authentication when making requests to the API Gateway.

User-AgentstringRequired

Identifies the application making the request.

Responses
200Success
application/json
get
GET /payment-destinations HTTP/1.1
Host: 
Authorization: Bearer YOUR_SECRET_TOKEN
x-api-key: text
User-Agent: text
Accept: */*

[
  {
    "name": "text",
    "type": "PAYMENT_LINK",
    "currency": "text",
    "settlement": "text",
    "fee": {
      "name": "text",
      "type": "FIXED",
      "value": "text",
      "amount": "text",
      "currency": "text"
    },
    "metadata": {
      "image": "text",
      "description": "text",
      "category": "text"
    },
    "card": {
      "holder": "text",
      "scheme": "text",
      "type": "text",
      "mask": "text",
      "country": "text",
      "tokenized": "text",
      "minimumAmount": "text",
      "maximumAmount": "text"
    }
  }
]
PreviousPaymentsNextPayment-attempts

Last updated