Skip to main content
POST
/
api
/
payments
/
transfer-initiations
Create a TransferInitiation
curl --request POST \
  --url http://localhost/api/payments/transfer-initiations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "reference": "XXX",
  "scheduledAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "sourceAccountID": "<string>",
  "destinationAccountID": "<string>",
  "connectorID": "<string>",
  "type": "TRANSFER",
  "amount": 123,
  "asset": "USD",
  "validated": true,
  "metadata": {}
}'
{
  "data": {
    "id": "XXX",
    "reference": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "scheduledAt": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "sourceAccountID": "<string>",
    "destinationAccountID": "<string>",
    "connectorID": "<string>",
    "provider": "<string>",
    "type": "TRANSFER",
    "amount": 123,
    "initialAmount": 123,
    "asset": "USD",
    "status": "WAITING_FOR_VALIDATION",
    "error": "<string>",
    "metadata": {},
    "relatedPayments": [
      {
        "paymentID": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "status": "PENDING",
        "error": "<string>"
      }
    ],
    "relatedAdjustments": [
      {
        "adjustmentID": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "status": "WAITING_FOR_VALIDATION",
        "error": "<string>",
        "metadata": {}
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
​
reference
string
required
Example:

"XXX"

​
scheduledAt
string<date-time>
required
​
description
string
required
​
sourceAccountID
string
required
​
destinationAccountID
string
required
​
type
enum<string>
required
Available options:
TRANSFER,
PAYOUT
​
amount
integer
required
​
asset
string
required
Example:

"USD"

​
validated
boolean
required
​
connectorID
string
​
metadata
object | null

Response

OK

​
data
object
required
⌘I