The payment initiation object - Yorlet Documentation

{
  "id": "<string>",
  "created": 123,
  "object": "payment_initiation",
  "type": "inbound_payment",
  "inbound_payment": {
    "type": "customer",
    "customer": "<string>"
  },
  "account": "<string>",
  "deleted": false,
  "amount": 123,
  "metadata": {},
  "reference": "<string>",
  "status": "<string>"
}

Option 1
Option 2
Option 3

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

Show child attributes

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

The amount of the payment initiation in the smallest currency unit.

currency

enum<string>

Three-letter ISO currency code, in lowercase.

Available options:

gbp,

sek

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.

Show child attributes

reference

string | null

A reference for the payment initiation.

status

string

The current status of the payment initiation.

Acknowledge the confirmation of payee

Create a payment initiation