Authorize Transfer
POST /v1/global-payout/transfer/authorize
Manage the complete transfer lifecycle with a single endpoint. AuthTransfer walks you through every required step from initiating a transfer to final authorization, ensuring nothing is missed before funds are moved.
Payment methods
ThepaymentMethod field determines which additional fields are required:
paymentMethod | Required fields | Optional fields |
|---|---|---|
BANK (non-Canada, e.g. DRC) | accountNumber, receiverName, institutionName (bank display name), institutionCode (bank code from /bank/providers) | narration |
BANK (Canada) | accountNumber, receiverName, institutionCode (institution number), beneficiary.beneficiaryEmail | beneficiary.securityQuestion, beneficiary.securityQuestionAnswer, beneficiary.transitNumber, narration |
MobileMoney | accountNumber (recipient phone number), receiverName, institutionName (provider display name) | narration |
INTERAC | receiverName, beneficiary.beneficiaryEmail | beneficiary.securityQuestion, beneficiary.securityQuestionAnswer |
FASTER_PAYMENTS | accountNumber, receiverName, institutionCode (sort code, 6 digits) | accountType (e.g. Individual, Corporate), narration |
SEPA | accountNumber (IBAN), receiverName, institutionCode (SWIFT/BIC) | accountType (e.g. Individual, Corporate), purposeOfPayment, narration |
Request body
The amount to transfer in the source currency.
ISO 4217 currency code of the source account (e.g.,
USD).ISO 4217 currency code of the destination account (e.g.,
USD, CDF, EUR, GBP, CAD).Full name of the recipient.
ISO 3166-1 alpha-2 country code of the sender (e.g.,
CD).ISO 3166-1 alpha-2 country code of the recipient (e.g.,
CD, GB, DE, CA).Authorization PIN to confirm the transaction.
Payment rail to use. One of:
BANK, MobileMoney, INTERAC, FASTER_PAYMENTS, SEPA.Recipient account number, IBAN, or phone number (for
MobileMoney). Required for BANK, MobileMoney, FASTER_PAYMENTS, and SEPA.Bank or institution routing code. For
BANK (DRC): bank code from List Institution Providers. For BANK (Canada): institution number. For FASTER_PAYMENTS: sort code (6 digits). For SEPA: SWIFT/BIC code.Bank or provider display name. For
BANK: the bank display name. For MobileMoney: the provider display name (e.g., Mpesa). Use the displayName from List Institution Providers.Account type of the recipient. Pass
Individual or Corporate. Required by some corridors — optional for FASTER_PAYMENTS and SEPA.Reason for the transfer. Optional for most corridors; required by some (e.g., SEPA corporate transfers).
Description or memo for the transfer.
The
exchangeRateId from a prior Fetch Exchange Rates or Convert Money call. Guarantees the transfer is fulfilled at that exact rate regardless of any subsequent market movement.Beneficiary details. Required for
INTERAC; partially required for BANK (Canada).Response body
Unique GlobalPayout transaction ID. Use this to track the transfer via Fetch Transaction.
Internal core transaction reference.
Processing status. One of:
PROCESSING, COMPLETED, FAILED, PENDING.Core system status (e.g.,
PAYMENT_SUCCESSFUL).Transaction type. Will be
TRANSFER for cross-border disbursements.Human-readable status label (e.g.,
Successful, Processing).Transaction metadata containing currency details, amounts, and routing info. This is a JSON object — only transaction-relevant fields are present.