GatewayPay Documentation
  1. APM - Payouts
GatewayPay Documentation
  • GatewayPay API Documentation
  • Authentication
  • Callbacks
  • Testing
  • Domains and IP Addresses
  • Account
    • Get Account profile details
      GET
    • Get Account balances
      GET
    • Get Account payment options
      GET
  • H2H flow
    • Status List
    • Create Payment Invoice
      POST
    • Send Card Data to the Gateway
      POST
    • Full List of Payment Services
      GET
    • Get Service Data by ID
      GET
    • Check Status of Payment Invoice by ID
      GET
    • Get list of Payment Invoices
      GET
  • Refunds
    • Refund
      POST
  • Cards Whitelist API
    • JSON
      POST
    • CSV
      POST
  • APM - Deposits
    • Bank Transfers - Turkey
      POST
  • APM - Payouts
    • Bank Transfers - Turkey (Invoice Initiation)
      POST
    • Bank Transfers - Turkey (Invoice processing)
      POST
  1. APM - Payouts

Bank Transfers - Turkey (Invoice processing)

POST
/payout-invoices/{id}/process

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 *****************
Path Params
id
string 
required
Header Params
Host
string 
optional
Example:
{{BASE_API_URL}}

Responses

🟢201Created
application/json
Body
object {0}
Example
{
    "data": {
        "type": "payout-invoices",
        "id": "cpoi_IdHWQr234f2lkDGT",
        "attributes": {
            "status": "process_pending",
            "resolution": "ok",
            "amount": 100,
            "payout_amount": 100,
            "currency": "TRY",
            "service_currency": "TRY",
            "service_amount": 100,
            "service_payout_amount": 100,
            "reference_id": "d68e752e-b42a-4e08-9a87-3abb7a8eb752",
            "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": 1732713989,
            "updated": 1732714003,
            "fields": {
                "account_number": "555555",
                "beneficiary_full_name": "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": null
            }
        },
        "links": {
            "self": "/api/payout-invoices/cpoi_IdHWQroqOi7lkDGT"
        }
    }
}
Modified at 2024-11-27 15:35:15
Previous
Bank Transfers - Turkey (Invoice Initiation)
Built with