Request and response samples

Payout - Wallet

Sample Request

curl --location 'https://payout.codapayments.com/payouts' \
--header 'X-API-Key: [Test_API_Key]' \
--header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJwYXJ0bmVyX2lkIjoicGFyX3NnMTg3MzI2ZjA4ZjB3cmtyMTA2IiwiaWF0IjoxNjgyNDIzNDg2fQ.bMYzPS5SIQz1w7zULOk_1h41atq_yFEH6UUkXZvJkSU' \
--header 'Content-Type: application/json' \
--data '{
  "payout_method": {
    "type": "wallet",
    "payment_method": "vodafone_cash",
    "beneficiary": {
      "name": "Test Name",
      "payout_method_details": {
        "phone_number": "01041164340",
      }
    }
  },
  "amount": {
    "value": "10.10",
    "currency_code": "EGP"
  },
  "country_code": "EG",
  "purpose": "salaries",
  "reference": "reference",
  "request_id": "request_id"
}'

Sample Response

{
   "purpose": "SALARIES",
   "reference": "reference",
   "id": "MDAwLjAuMTY4MDAxMjM3MC4xMw==",
   "payout_method": {
       "type": "wallet",
       "payment_method": "vodafone_cash",
       "beneficiary_details": {
           "name": "Test Name"
       }
   },
   "amount": {
       "value": 10.1,
       "currency_code": "EGP"
   },
   "country_code": "EG",
   "request_id": "request_id",
   "created_at": 1680012370
}

Payout - Bank transfer

Sample Request

curl --location 'https://payout.codapayments.com/payouts' \
--header 'X-API-Key: [Test_API_Key]' \
--header 'Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJwYXJ0bmVyX2lkIjoiMTIzNDU2Nzg5MCJ9.C7P8eXc2U66zFztQnUQEZX0aSLumKC2TjMGroBC80IE' \
--header 'Content-Type: application/json' \
--data '{
  "payout_method": {
    "type": "bank_transfer",
    "payment_method": "bank_transfer",
    "beneficiary": {
      "name": "Test Name",
      "payout_method_details": {
        "account_currency": "EGP",
        "account_name": "Test Name",
        "account_number": "34343545",
        "iban": "EG829299835700000000001111111",
        "swift_code": "DEIBEGCX016"
      }
    }
  },
  "amount": {
    "value": "10.100"
  },
  "country_code": "EG",
  "purpose": "salaries",
  "reference": "reference",
  "request_id": "request_id"
}'

Sample Response

{
   "purpose": "SALARIES",
   "reference": "reference",
   "id": "MDAwLjAuMTY4MDAxMjIzNC4xMQ==",
   "payout_method": {
       "type": "bank_transfer",
       "payment_method": "bank_transfer",
       "beneficiary_details": {
           "name": "Test Name"
       }
   },
   "amount": {
       "value": 10.1,
       "currency_code": "EGP"
   },
   "country_code": "EG",
   "request_id": "request_id",
   "created_at": 1680012234
}