Payouts by Token¶

Process consistency:

Make at least one successful payment with tokenisation to obtain a token
Initiate a payout by this token (use it instead of card number)

Info

Service fields have priority over the token. So if you send both token and card number in the request, the system will use the card number.

API: PRIVATE

Endpoint: /payout-invoices

Authentication: BasicAuth

Method: POST

Request Sample (JSON)

{
  "data":{
      "type":"payout-invoice",
      "attributes":{
        "test_mode": false,
        "reference_id": "my_order_id123",
        "description": "some description",
        "currency": "USD",
        "amount": 100.78,
        "service": "payment_card_usd",
        "service_amount": 100.78,
        "token": "1Wrmk47zNKIGbo57znUzGy5ircN1FhPd",
        "callback_url": "https://example.com/payouts/callback",
        "options":{
            "auto_process":true
        },
        "customer":{
            "reference_id":"1203515",
            "email":"[email protected]",
            "name":"John Wick",
            "metadata":{
              "key1":"value1",
              "key2":"value2"
            }
        },
        "metadata":{
            "key":"value"
      }
    }
  }
}