api Server access API endpoints
POST/api/clients/card_numberRegister a client cardv
Create a client registration request from an approved server access client.
POST/api/clients/approval-code/resetRequest an owned client's approval-code reset emailv
Owned-client operations-v1. Requires CLIENT_OPERATIONS_READ plus the action permission for POST. Poll operation status; never create a new request after an uncertain outcome. No bank/card refund proof is implied by an internal debit.
POST/api/clients/card-number/checkCheck an owned registered cardv
Owned-client operations-v1. Requires CLIENT_OPERATIONS_READ plus the action permission for POST. Poll operation status; never create a new request after an uncertain outcome. No bank/card refund proof is implied by an internal debit.
POST/api/clients/refundsRequest gateway-approved internal client refund debitv
Owned-client operations-v1. Requires CLIENT_OPERATIONS_READ plus the action permission for POST. Poll operation status; never create a new request after an uncertain outcome. No bank/card refund proof is implied by an internal debit.
GET/api/clients/operations/statusRead own client-operation statusv
Owned-client operations-v1. Requires CLIENT_OPERATIONS_READ plus the action permission for POST. Poll operation status; never create a new request after an uncertain outcome. No bank/card refund proof is implied by an internal debit.
GET/api/clients/operations/capabilitiesRead client-operation permissions and required host featuresv
Owned-client operations-v1. Requires CLIENT_OPERATIONS_READ plus the action permission for POST. Poll operation status; never create a new request after an uncertain outcome. No bank/card refund proof is implied by an internal debit.
POST/api/transfers/swiftSubmit a SWIFT transferv
Submit a SWIFT transfer request for processing and gateway confirmation. For merchant-wallet funding, client_id may be MERCHANT and is treated as audit identity, not a card payer.
POST/api/transfers/wireSubmit a WIRE transferv
Submit a WIRE transfer request for processing and gateway confirmation. For merchant-wallet funding, client_id may be MERCHANT and is treated as audit identity, not a card payer.
POST/api/transfers/rtgsSubmit an RTGS transferv
Submit an RTGS transfer request for processing and gateway confirmation. For merchant-wallet funding, client_id may be MERCHANT and is treated as audit identity, not a card payer.
POST/api/transfers/cryptoSubmit a crypto transferv
Submit a crypto transfer request for processing and gateway confirmation. For merchant-wallet funding, client_id may be MERCHANT and is treated as audit identity, not a card payer.
GET/api/transfers/statusRead transfer statusv
Read current transfer status by reference.
GET/api/transfers/documentsRead confirmation documentv
Read confirmation metadata and printable document links.
GET/api/transfers/documents/downloadRead confirmation documentv
Read confirmation metadata and printable document links.
GET/api/transfers/documents/ackRead confirmation documentv
Read confirmation metadata and printable document links.
GET/api/confirmations/readRead confirmation documentv
Read confirmation metadata and printable document links.
GET/api/statementRead statement datav
Read statement records for an approved server access client.
GET/api/statements/readRead statement datav
Read statement records for an approved server access client.
POST/api/settlementRequest or read settlement datav
POST /api/settlements/approval creates an approval settlement client server request and submits it to the gateway for approve, decline, or not answered results. POST /api/settlement reads existing settlement data and does not create a settlement.
POST/api/settlements/approvalRequest or read settlement datav
POST /api/settlements/approval creates an approval settlement client server request and submits it to the gateway for approve, decline, or not answered results. POST /api/settlement reads existing settlement data and does not create a settlement.
POST/api/settlements/readRequest or read settlement datav
POST /api/settlements/approval creates an approval settlement client server request and submits it to the gateway for approve, decline, or not answered results. POST /api/settlement reads existing settlement data and does not create a settlement.
POST/api/fx/quotesCreate a locked FX quotationv
Lock an exchange rate, fees, source debit, destination amount, and expiry before a cross-currency transfer. Provide exactly one of source_amount or destination_amount; use destination_amount when the operator enters the payout amount. For merchant-wallet funding, client_id may be MERCHANT and funding_source must be merchant_wallet.