Withdrawal Order

Developing

POST

/payout-invoices

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Example

{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "service": "payment_card_usd",
      "currency": "USD",
      "amount": 100,
      "reference_id": "16091051-111111-acea-4ffc-b033-1111111",
      "test_mode": false,
      "description": "test01",
      "fields": {
        "card_number": "412661******1249"
      },
      "customer": {
        "reference_id": "16091051-111111-acea-4ffc-b033-1111111",
        "name": "John Wick",
        "phone": "7111111111",
        "email": "test@gmail.com"
      },
      "context": {
        "card": {
          "exp_year": "99",
          "exp_month": "01"
        }
      },
      "options": {
        "split_mode": false,
        "parallel_mode": false,
        "allow_partially": false,
        "auto_process": true
      }
    }
  }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/payout-invoices' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "service": "payment_card_usd",
      "currency": "USD",
      "amount": 100,
      "reference_id": "16091051-111111-acea-4ffc-b033-1111111",
      "test_mode": false,
      "description": "test01",
      "fields": {
        "card_number": "412661******1249"
      },
      "customer": {
        "reference_id": "16091051-111111-acea-4ffc-b033-1111111",
        "name": "John Wick",
        "phone": "7111111111",
        "email": "test@gmail.com"
      },
      "context": {
        "card": {
          "exp_year": "99",
          "exp_month": "01"
        }
      },
      "options": {
        "split_mode": false,
        "parallel_mode": false,
        "allow_partially": false,
        "auto_process": true
      }
    }
  }
}'

Responses

🟢201Created

application/json

Body

Example

{
    "data": {
        "type": "payout-invoices",
        "id": "cpoi_2hLiXaEsmwML111j",
        "attributes": {
            "status": "created",
            "resolution": "ok",
            "amount": 100,
            "payout_amount": 100,
            "currency": "USD",
            "service_currency": "USD",
            "service_amount": 100,
            "service_payout_amount": 100,
            "reference_id": "1111111-a3a2028b-acea-4ffc-b033-1111111111",
            "test_mode": false,
            "description": "test description",
            "fee": 4.8,
            "writeoff": 104.8,
            "exchange_rate": 1,
            "processed": null,
            "processed_amount": null,
            "processed_fee": null,
            "processed_writeoff": null,
            "metadata": [],
            "created": 1723457234,
            "updated": 1723457234,
            "fields": {
                "card_number": "111111******1111"
            },
            "callback_url": null,
            "source": "merchant_api",
            "callback_logs": [],
            "moderation_required": false,
            "payouts": []
        },
        "relationships": {
            "payout-service": {
                "data": {
                    "type": "payout-services",
                    "id": "payment_card_usd"
                }
            },
            "payout-method": {
                "data": {
                    "type": "payout-methods",
                    "id": "payment_card"
                }
            },
            "customer": {
                "data": {
                    "type": "customers",
                    "id": "cus_iFv2duBXXZoamL11"
                }
            }
        },
        "links": {
            "self": "/api/payout-invoices/cpoi_2hLiXaEsmwMLe111"
        }
    }
}

Modified at 2024-12-12 13:18:26

Merch Deposit Order status

Payment Order