GET
/
api
/
payments
/
transfer-initiations
/
{transferId}
Get a transfer initiation
curl --request GET \
  --url http://localhost:55001/api/payments/transfer-initiations/{transferId} \
  --header 'Authorization: Bearer <token>'
{
  "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.

Path Parameters

​
transferId
string
required

The transfer ID.

Response

200
application/json

OK

The response is of type object.