Sign in
latestOpenAPI 3.1.02026-08-102051102.0 KB

40ed0bdb89e1

Transfers

Initiate an offramp payment for an existing customer

post/api/v1/transfer

Headers

idempotency-keystring uuid required

Required for mutating calls. Use a V4 UUID. The server stores the first result for 24h and returns it on subsequent retries with the same key.

Required for mutating calls. Use a V4 UUID. The server stores the first result for 24h and returns it on subsequent retries with the same key.

Request body

quote_idstring uuid required

UUID

customer_idstring uuid required

Customer UUID

metadataMetadata
purpose_code'PAYMENT_FOR_SERVICES' | 'PAYMENT_FOR_SOFTWARE' | 'PAYMENT_FOR_IMPORTED_GOODS' | 'TRAVEL_SERVICES' | 'VENDOR_CONTRACTOR_PAYOUTS' | 'TRANSFER_TO_OWN_ACCOUNT' | 'INVESTMENT_IN_SHARES' | 'PURCHASE_OF_PROPERTY' | 'REPAYMENT_OF_LOANS' | 'SALARY' | 'PAYMENT_OF_PROPERTY_RENTAL' | 'INFORMATION_SERVICE_CHARGES' | 'ADVERTISING_PR_EXPENSES' | 'ROYALTY_FEES' | 'BROKER_COMMITMENT_FEES' | 'ADVISOR_TECHNICAL_FEES' | 'REPRESENTATIVE_OFFICE_EXPENSES' | 'TAX_PAYMENT' | 'TRANSPORTATION_FEES_FOR_GOODS' | 'CONSTRUCTION_COSTS' | 'INSURANCE_PREMIUM' | 'GENERAL_GOODS_TRADES' | 'INSURANCE_CLAIMS_PAYMENT' | 'FAMILY_MAINTENANCE' | 'EDUCATION_EXPENSES' | 'MEDICAL_TREATMENT' | 'DONATIONS' | 'MUTUAL_FUND_INVESTMENT' | 'CURRENCY_EXCHANGE' | 'USER_WITHDRAWAL' | 'ADVANCE_PAYMENTS_FOR_GOODS' | 'VENDOR_CONTRACTOR_SOFTWARE_PAYOUTS' | 'MERCHANT_SETTLEMENT' | 'REPATRIATION_FUND_SETTLEMENT' | 'PERSONAL_REMITTANCE' | 'RETURN_OF_FUNDS'

Purpose of the transfer

Response

Default Response

idstring uuid required
tenant_idstring uuid required
customer_idstring uuid required
quote_idstring uuid required
type'offramp' | 'onramp' required

Type of transfer: offramp (crypto to fiat) or onramp (fiat to crypto)

status'created' | 'unknown' | 'compliance_hold' | 'awaiting_funds_collection' | 'funds_collected' | 'in_progress' | 'payment_submitted' | 'payment_processed' | 'completed' | 'failed' | 'cancelled' | 'expired' required

Status of the transfer in display format

created_atstring date-time required
updated_atstring date-time required
metadataMetadata
exchange_ratenumber nullable
origin'api' | 'otc' required