Skip to main content
POST
/
v1
/
payment_initiations
Create a payment initiation
curl --request POST \
  --url https://api.yorlet.com/v1/payment_initiations \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": 123,
  "currency": "gbp",
  "type": "inbound_payment",
  "inbound_payment": {
    "type": "customer",
    "customer": "<string>"
  },
  "metadata": {},
  "reference": "<string>"
}
'
{
  "id": "<string>",
  "created": 123,
  "object": "payment_initiation",
  "type": "inbound_payment",
  "inbound_payment": {
    "type": "customer",
    "customer": "<string>"
  },
  "account": "<string>",
  "deleted": false,
  "amount": 123,
  "currency": "gbp",
  "reference": "<string>",
  "metadata": {}
}

Authorizations

​
Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Body

application/json
​
amount
integer
required
​
currency
enum<string>
required
Available options:
gbp,
sek
​
type
enum<string>
required
Available options:
inbound_payment
​
inbound_payment
object
required
​
metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

​
reference
string
Required string length: 1 - 18
Pattern: ^[a-zA-Z0-9]*$

Response

200 - application/json

Returns the payment initiation object if the request succeeded.

​
id
string
required

Unique identifier for the object.

​
created
number
required

Time at which the object was created. Measured in seconds since the Unix epoch.

​
object
enum<string>
required
Available options:
payment_initiation
​
type
enum<string>
required
Available options:
inbound_payment
​
inbound_payment
object
required

The inbound payment details

​
account
string

The account that the object belongs to. Only returned if the request is made with a valid Yorlet-Context header.

​
deleted
boolean
default:false

Only returned if the object has been deleted.

​
amount
integer
​
currency
enum<string>
Available options:
gbp,
sek
​
reference
string | null
​
metadata
object

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.