Payments Overview
Payments can be initiated to a customer's phone number, email, or mailing address.
Payments
Payments are uniquely identified by payment_id
Payments can be initiated to a phone number, email address, or both, for payments to a digital wallet
Payments can be initiated to a physical mailing address for payments to paper check
Payment Statuses
SUCCESS
- Payment was credited to the balance associated with phone number or email address
SUCCESS
- Payment was credited to the balance associated with phone number or email addressFAILED
- Payment was not credited to the balance
FAILED
- Payment was not credited to the balanceCANCELLED
- Payment was previously credited, but later revoked
CANCELLED
- Payment was previously credited, but later revokedIdempotency
Integrators may optionally associate an idempotency_key
with each payment.
Using the idempotency_key
prevents duplicate submission of payments to customers. Payment initiation will fail if there exists a payment with status
= SUCCESSFUL
with the same idempotency_key.
Payments with
STATUS
=FAILED
orCANCELLED
can be re-initiated with the sameidempotency_key
Last updated