Payment instructions

Base URL: $PUBLIC_API

The object

methodsarray of string · required

Payment method keys accepted for platform invoices

instructionsarray of PublicPaymentInstruction · required

Operator-configured payment details; empty when none

Show child attributes
labelstring · required

What the value is

valuestring · required

The value to use when paying

The object
{
  "methods": [
    "method"
  ],
  "instructions": [
    {
      "label": "Account number",
      "value": "value"
    }
  ]
}

How platform invoices can be paid

Logs

GET /payment-instructions

Returns, without sign-in, the payment method keys the platform accepts for its own invoices (taken from the enabled payment connectors at runtime) and the label and value pairs the operator configured, such as account details. instructions is empty when none are configured. Responses may be cached for 5 minutes.

Returns

200 Accepted methods and payment instructions

Show attributes
methodsarray of string · required

Payment method keys accepted for platform invoices

instructionsarray of PublicPaymentInstruction · required

Operator-configured payment details; empty when none

Show child attributes
labelstring · required

What the value is

valuestring · required

The value to use when paying

curl -X GET "$PUBLIC_API/payment-instructions"
Response 200
{
  "methods": [
    "method"
  ],
  "instructions": [
    {
      "label": "Account number",
      "value": "value"
    }
  ]
}