List all payment initiations

GET /api/payments/v3/payment-initiations

Try it

List all payment initiations

cURL

curl --request GET \
  --url http://localhost/api/payments/v3/payment-initiations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

{
  "cursor": {
    "pageSize": 15,
    "hasMore": false,
    "data": [
      {
        "id": "<string>",
        "connectorID": "aSDinaTvuI8gbWludGxpZnk=",
        "provider": "<string>",
        "reference": "<string>",
        "createdAt": "2023-11-07T05:31:56Z",
        "scheduledAt": "2023-11-07T05:31:56Z",
        "description": "<string>",
        "type": "UNKNOWN",
        "amount": 123,
        "asset": "<string>",
        "status": "UNKNOWN",
        "sourceAccountID": "aSDinaTvuI8gbWludGxpZnk=",
        "destinationAccountID": "aSDinaTvuI8gbWludGxpZnk=",
        "error": "<string>",
        "metadata": {}
      }
    ],
    "previous": "YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol=",
    "next": ""
  }
}

Authorizations

Authorization · string · header · required

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

Query Parameters

pageSize · integer<int64>

The number of items to return

Required range: 1 <= x <= 1000

cursor · string

Parameter used in pagination requests. Set to the value of next for the next page of results. Set to the value of previous for the previous page of results. No other parameters can be set when this parameter is set.

Body

application/json

The body is of type object.

Response

200

application/json

OK

cursor · object · required

Show child attributes

cursor. pageSize · integer<int64> · required

Required range: x >= 1

Example:

15

cursor. hasMore · boolean · required

Example:

false

cursor. data · object[] · required

Show child attributes

cursor.data. id · string · required

cursor.data. connectorID · string<byte> · required

cursor.data. provider · string · required

cursor.data. reference · string · required

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

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

cursor.data. description · string · required

cursor.data. type · enum<string> · required

Available options: UNKNOWN, TRANSFER, PAYOUT

cursor.data. amount · integer<bigint> · required

cursor.data. asset · string · required

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

Available options: UNKNOWN, WAITING_FOR_VALIDATION, SCHEDULED_FOR_PROCESSING, PROCESSING, PROCESSED, FAILED, REJECTED, REVERSE_PROCESSING, REVERSE_FAILED, REVERSED

cursor.data. sourceAccountID · string<byte>

cursor.data. destinationAccountID · string<byte>

cursor.data. error · string | null

cursor.data. metadata · object

Show child attributes

cursor.data.metadata. {key} · string

cursor. previous · string

Example:

"YXVsdCBhbmQgYSBtYXhpbXVtIG1heF9yZXN1bHRzLol="

cursor. next · string

Example:

""