Payments APIs Overview

These APIs help to enable secure, flexible, and automated payment workflows across customer accounts, with closed loop transactions and account-specific minimum payment handling.

Payments API Endpoints

Get Payment Details for Given Account

GET /programs/{programCode}/accounts/{accountIdentifier}/payments

Return last calculated Minimum Payment

After a customer schedules a one-time SCC payment and chooses the minimum-amount option, the BaaS GetSccPayment API returns this amount to Gateway so that it can request FundTransfer or CreateAmmRule with the correct amount.

Pre-authorize a closed loop transaction

POST /programs/{programCode}/payments/authorize

This API serves as the authorization for a closed loop transaction.

Get status of a closed loop transaction

GET /programs/{programCode}/payments/{paymentInstrumentIdentifier}/status/{retrievalReferenceNumber}

This API retrieves the status of a closed loop transaction.