sharePayments 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

FAILED - Payment was not credited to the balance

CANCELLED - Payment was previously credited, but later revoked

circle-info

Information about "claim status" (e.g. did the user login to redeem the payment) can be found in the reporting

Idempotency

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 or CANCELLED can be re-initiated with the same idempotency_key

Last updated