Skip to main content
A payment (pay_*) moves money from your wallet to another party or agent. When the recipient is an email or phone number with no Natural account, the payment waits as a claim until they claim it. To learn more, see Send a payment and Track a payment.

Example

GET /payments/{paymentId}
The object is everything inside data. The field names below are relative to it: attributes.amount is data.attributes.amount in the response.

Fields

string
required
Resource type. Always payment.
string
required
Payment ID (pay_*).
object
required
The payment’s details.
object
required
Resources the payment links to.

Statuses

Events

  • payment.created: A payment resource was created before approval or money movement submission. The fee is assessed when the payment is sent, so it’s always null on payment.created. Only the sender’s copy carries it. Payments that pay a payment request never carry a fee; the request fee is on paymentRequest.completed.
  • payment.completed: A payment reached the public completed state.
  • payment.failed: A payment failed during submit or money movement processing.
  • payment.returned: A completed return-capable payment was returned.
  • payment.canceled: A payment was canceled before money movement processing.
  • payment.approvalDenied: A payment approval was explicitly denied before money movement processing.

Endpoint differences

These endpoints return the object with a difference:
  • POST /payments also returns claimLink, the only time it is shown.

Errors

See the error codes these endpoints return.

Sandbox simulations