Create a transfer

Creates a payout, or Original Credit Transaction (OCT), to a tokenized card and returns the credit result. A transfer pushes funds from your settlement account at the payout partner to the beneficiary's card.

Only card payouts are supported in this version (transfer_type: oct). Each call creates one order with category: payout and one transaction of type credit.

Where this request fits

  1. Tokenize

    Tokenize the beneficiary card with Create a token. Never send a card number in this request.

  2. Create the transfer

    Send this request with the token in destination_account_token, the purpose and your order_merchant_id.

  3. Follow the result

    Read status. For a pending result, wait for the webhook or call Retrieve a transfer.

Rules

Payouts are final once credited

Use a unique order_merchant_id per payout: a duplicate is rejected with 861003. The platform never retries a credit: on credit_request_failed, check the transfer before you submit a new one.

RuleDetails
merchant_contractRequired. Payouts are not routed automatically.
Rejected fieldsoperation_typetoken3ds_dataauthentication_indicatorchallenge_preferencesca_exemption_reasonaccept_urldecline_urlpending_urlexception_urlbasket_contentshipping_*save_payment_informationscheduled_capture_delayis_aftsub_merchant_idsub_merchant_namepayfac_idpayfac_nameforeign_retail_indicatormerchant_category_code

Sending any of them returns 111012.

Purpose and country rulesSee Specification.

Result

statusWhat it means
credit_successfulFunds sent to the beneficiary.
credit_declinedRefused by the partner or the issuer. No funds moved.
credit_requestedPending at the partner. Wait for the webhook.
credit_request_failedTechnical failure, result unknown. Call Retrieve a transfer before any new attempt.
eligibility_declinedThe card cannot receive a payout.

See Processing a payout for all statuses, return codes and webhooks.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required
Defaults to oct

Type of transfer. Only oct (card payout) is accepted.

Allowed:
string
enum
required
Defaults to online_gambling_payout

Business purpose of the payout. The platform derives the scheme codes (Visa BAI, Mastercard TTI) from it. See Payout specification and Available values.

string

ISO purpose code, for example ISPAYR, ISSALA or ISOTHR. Required for beneficiaries in AR, BD, CL, CO, EG, IN and SA.

string
length ≤ 35

Reference shown to the beneficiary. Up to 35 characters.

number
required
Defaults to 250

Amount of the payout in major units, for example 250.00.

string
required
Defaults to EUR

Three-letter ISO 4217 currency code.

string
required
Defaults to PAYOUT-2026-11-0041

Your unique identifier for this payout. Unique per API key: a duplicate is rejected with 861003.

string
required
Defaults to 69fb373bacda23a62375d5b0

Identifier of the payout contract to use. Required: payouts are not routed automatically.

string

Scheme of the destination card, for example visa or mastercard. Derived from the token when omitted.

string

Descriptor shown on the beneficiary's statement, when the partner supports it.

string

transaction_id of the original payin, when the payout returns funds to a card charged through the platform. Must belong to your merchant account and be captured. Do not send it with psp_original_transaction_id (861005).

string

Partner-side identifier of an original payment not processed by the platform. Passed through as is. Some partners require one of the two references (861006 otherwise). Do not send it with original_transaction_id.

string

Free text describing the payout.

string

Payment channel. Defaults to e-commerce.

string

Same meaning as on Create an order.

string

Same meaning as on Create an order.

string

Same meaning as on Create an order.

string
enum
required
Defaults to card

Type of the destination account. Only card is accepted in this version.

Allowed:
string
required
Defaults to 3554757d2b2039e34d4f43950ba1ac475904492b9d03d2b964f237ad51a0ec16

Token of the beneficiary card, from Create a token (oneshot or recurring). Never send a card number in this request.

string
Defaults to PLAYER-0635656565

Your identifier of the beneficiary, for example a player, seller or wallet ID.

boolean

true when the beneficiary is the customer described by the customer_* fields. The destination account name fields then become optional.

string
Defaults to John

First name of the beneficiary. Required unless destination_account_is_customer is true.

string
Defaults to Doe

Last name of the beneficiary. Required unless destination_account_is_customer is true.

string
required
Defaults to FR

Two-letter ISO country code of the beneficiary.

string

Street address of the beneficiary. Required for beneficiaries in CA, AU and NZ.

string

City of the beneficiary. Required for beneficiaries in CA, AU and NZ.

string

State, province or region of the beneficiary. Required for beneficiaries in CA, AU and NZ.

string

Postal code of the beneficiary. Required for beneficiaries in CA, AU and NZ.

date

Birth date of the beneficiary, YYYY-MM-DD. May be required for cross-border payouts.

string

Reserved for future bank account transfers. Not allowed with destination_account_type: card: a card number sent here is rejected with 861007.

string

First name of the sender. Use the sender_* fields only for PayFac, marketplace or on-behalf-of payouts. When omitted, the merchant of the contract is the sender.

string

Last name of the sender.

string

Company name of the sender.

string

Street address of the sender.

string

City of the sender.

string

State, province or region of the sender.

string

Postal code of the sender.

string

Two-letter ISO country code of the sender.

date

Birth date of the sender, YYYY-MM-DD.

string

Your reference for the sender.

string
enum

Type of the sender's account.

Allowed:
string
enum

Source of the sender's funds.

string

Customer first name. The customer_* fields have the same meaning as on Create an order.

string

Customer last name.

string

Customer email address.

string

Two-letter ISO country code of the customer.

Headers
string
required
Defaults to 1.0.0

API version. Use 1.0.0.

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json