Programmable

Create Programmable Payment Request

Creates a programmable payment request.

Required body fields depend on the initiator query parameter:

initiatorBody schemaRequired fields
recipientRecipientRequestPayloadcounterPartyId, recipientWalletId, amount
payerPayerRequestPayloadcounterPartyId, senderWalletId, amount

Optional on both: feeAmount, description. Optional business override: recipientBusinessId (recipient) or senderBusinessId (payer) — if omitted, derived from the wallet ID.

  • initiator=recipient — you (recipient) request payment from the counterparty.
  • initiator=payer — you (payer) offer to pay the counterparty.
post/payments/programmable

Request

Query parameters

initiator'recipient' | 'payer' required

Who initiates the payment: recipient or payer. Determines which body schema to send.

Request body

OR

Example request

{
  "counterPartyId": "550e8400-e29b-41d4-a716-446655440001",
  "recipientWalletId": "550e8400-e29b-41d4-a716-446655440000",
  "amount": "100.0",
  "description": "Invoice for services"
}

Response

Request Accepted

OR

Changes

No recorded changes to this operation across all 1 revision of this API.