Get a transfer initiation

GET /api/payments/transfer-initiations/{transferId}

Try it

Get a transfer initiation

cURL

curl --request GET \
  --url http://localhost/api/payments/transfer-initiations/{transferId} \
  --header 'Authorization: Bearer <token>'

200

{
  "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

data · object · required

Show child attributes

data. id · string · required

Example:

"XXX"

data. reference · string · required

data. createdAt · string<date-time> · required

data. scheduledAt · string<date-time> · required

data. description · string · required

data. sourceAccountID · string · required

data. destinationAccountID · string · required

data. connectorID · string · required

data. provider · string | null · required

data. type · enum<string> · required

Available options: TRANSFER, PAYOUT

data. amount · integer<bigint> · required

data. initialAmount · integer<bigint> · required

data. asset · string · required

Example:

"USD"

data. status · enum<string> · required

Available options: WAITING_FOR_VALIDATION, PROCESSING, PROCESSED, FAILED, REJECTED, VALIDATED, ASK_RETRIED, ASK_REVERSED, REVERSE_PROCESSING, REVERSE_FAILED, PARTIALLY_REVERSED, REVERSED

data. error · string | null

data. metadata · object

Show child attributes

data.metadata. {key} · string

data. relatedPayments · object[] | null

Show child attributes

data.relatedPayments. paymentID · string · required

data.relatedPayments. createdAt · string<date-time> · required

data.relatedPayments. status · enum<string> · required

Available options: PENDING, SUCCEEDED, CANCELLED, FAILED, EXPIRED, REFUNDED, REFUNDED_FAILURE, DISPUTE, DISPUTE_WON, DISPUTE_LOST, OTHER

data.relatedPayments. error · string | null

data. relatedAdjustments · object[]

Show child attributes

data.relatedAdjustments. adjustmentID · string · required

data.relatedAdjustments. createdAt · string<date-time> · required

data.relatedAdjustments. status · enum<string> · required

Available options: WAITING_FOR_VALIDATION, PROCESSING, PROCESSED, FAILED, REJECTED, VALIDATED, ASK_RETRIED, ASK_REVERSED, REVERSE_PROCESSING, REVERSE_FAILED, PARTIALLY_REVERSED, REVERSED

data.relatedAdjustments. error · string | null

data.relatedAdjustments. metadata · object

Show child attributes

data.relatedAdjustments.metadata. {key} · string