Bank Transfers - Turkey (Invoice Initiation)

POST

/payout-invoices

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string {{Username}}:{{Password}}

Example:

Authorization: Basic *****************

Header Params

Host

string

optional

Example:

Body Params application/json

data

object

required

type

string

required

attributes

object

required

Example

{
  "data": {
    "type": "payout-invoice",
    "attributes": {
      "reference_id": "{{$guid}}",
      "service": "bank_transfer_try",
      "amount": 100,
      "currency": "TRY",
      "test_mode": false,
      "fields": {
        "account_number": "555555",
        "beneficiary_full_name": "Test Test"
      },
      "customer": {
        "reference_id": "1",
        "name": "Test Test",
        "email": "test@gmail.com",
        "phone": "+44444444444",
        "date_of_birth": "2000-01-02",
        "individual_tax_id": "44444444444",
        "address": {
          "full_address": "Test test",
          "country": "TR",
          "region": "Test",
          "city": "Test",
          "street": "Test",
          "post_code": "AAA5555"
        }
      },
      "options": {
        "split_mode": false,
        "parallel_mode": false,
        "allow_partially": false,
        "auto_process": false
      },
      "metadata": {
        "key": "value"
      },
      "callback_url": "https://example.com"
    }
  }
}

Responses

🟢201Created

application/json

Body

object {0}

Example

{
  "data": {
    "type": "payout-invoices",
    "id": "cpoi_Lot6CiGEI2bX2dw0",
    "attributes": {
      "status": "created",
      "resolution": "ok",
      "amount": 100,
      "payout_amount": 100,
      "currency": "TRY",
      "service_currency": "TRY",
      "service_amount": 100,
      "service_payout_amount": 100,
      "reference_id": "21336d7e-3637-412a-bb41-fc9f56339341",
      "test_mode": false,
      "description": null,
      "fee": 0,
      "writeoff": 100,
      "exchange_rate": 1,
      "failed": null,
      "processed": null,
      "processed_amount": null,
      "processed_fee": null,
      "processed_writeoff": null,
      "metadata": {
        "key": "value"
      },
      "created": 1732718168,
      "updated": 1732718168,
      "fields": {
        "account_number": "555555",
        "beneficiary_full_name": "Test Test"
      },
      "callback_url": "https://example.com",
      "source": "merchant_api",
      "callback_logs": [],
      "moderation_required": false,
      "payouts": []
    },
    "relationships": {
      "payout-service": {
        "data": {
          "type": "payout-services",
          "id": "bank_transfer_try"
        }
      },
      "payout-method": {
        "data": {
          "type": "payout-methods",
          "id": "bank_transfer"
        }
      },
      "customer": {
        "data": {
          "type": "customers",
          "id": "cus_s1Zxx32fEd0lvsK"
        }
      }
    },
    "links": {
      "self": "/api/payout-invoices/cpoi_Lot6C23f23f2dw0"
    }
  }
}

Modified at 2024-11-27 15:35:15

Bank Transfers - Turkey

Bank Transfers - Turkey (Invoice processing)