Skip to main content
GET
/
v1
/
payment_initiations
List all payment initiations
curl --request GET \
  --url https://api.yorlet.com/v1/payment_initiations \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "has_more": false,
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "created": 123,
      "object": "payment_initiation",
      "type": "inbound_payment",
      "inbound_payment": {
        "type": "customer",
        "customer": "<string>"
      },
      "account": "<string>",
      "deleted": false,
      "amount": 123,
      "reference": "<string>",
      "metadata": {}
    }
  ]
}

Authorizations

​
Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Response

200 - application/json

A object with a data property that contains an array of payment initiations.

​
count
number
required

Total number of items in the list.

Example:

1

​
has_more
boolean
required

Whether more items are available.

Example:

false

​
object
enum<string>
required
Available options:
list
​
data
object[]
required