STstreampay
Payments

Auto Charge On Demand

Charge a payment using the consumer's latest tokenized card.

This endpoint allows organizations to charge a payment using the consumer's latest active tokenized card. The following conditions must be met:

  • The consumer must have at least one active tokenized card.
  • The payment must be in an unpaid status (PENDING, PROCESSING, FAILED, etc.).

This is a restricted API and is only available to some organizations.

post/api/v2/payments/auto-charge-on-demand/{payment_id}

Request

  • Base URL
    https://stream-app-service.streampay.sa
  • Auth
    • HTTP bearer
    • or API key in header x-api-key

Path parameters

payment_idstring uuid required

Unique identifier (UUID) of the payment to charge

Response

Successful Response

payment_idstring uuid

ID of the payment that was charged

invoice_idstring uuid

ID of the invoice associated with the payment

Changes

No recorded changes to this operation across all 15 revisions of this API.