Bank Transfers - Turkey

POST

/payment-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": "payment-invoices",
    "attributes": {
      "reference_id": "{{$guid}}",
      "amount": 100,
      "currency": "TRY",
      "service": "bank_transfer_try_hpp",
      "flow": "charge",
      "test_mode": false,
      "description": "Invoice Example",
      "customer": {
        "reference_id": "1203515",
        "email": "somename@domain.com",
        "name": "John Wick"
      },
      "metadata": {
        "key": "value"
      },
      "return_url": "https://example.com",
      "callback_url": "https://example.com"
    }
  }
}

Responses

🟢201Created

application/json

Body

object {0}

Example

{
  "data": {
    "type": "payment-invoices",
    "id": "cpi_SjNNO3455qtQGsq",
    "attributes": {
      "status": "process_pending",
      "resolution": "ok",
      "moderation_required": false,
      "amount": 100,
      "payment_amount": 100,
      "currency": "TRY",
      "service_amount": null,
      "payment_service_amount": null,
      "exchange_rate": null,
      "service_currency": "TRY",
      "reference_id": "ec6dfd73-3314-4b46-930d-5fef970de59a",
      "test_mode": false,
      "fee": 0,
      "deposit": 100,
      "processed": null,
      "processed_amount": null,
      "refunded_amount": null,
      "refunded_fee": null,
      "refunded": null,
      "processed_fee": null,
      "processed_deposit": null,
      "failed": null,
      "metadata": [],
      "flow_data": {
        "action": "https://URL_to_continue_payment",
        "method": "GET",
        "params": [],
        "metadata": []
      },
      "flow": "hpp",
      "payment_flow": "charge",
      "created": 1732712812,
      "updated": 1732712812,
      "payload": null,
      "description": "Test TEST",
      "descriptor": null,
      "callback_url": "https://example.com",
      "return_url": "https://example.com",
      "return_urls": {
        "fail": "https://example.com/3",
        "pending": "https://example.com/2",
        "success": "https://example.com/1"
      },
      "original_data": {
        "original_resolution": null,
        "original_resolution_message": null
      },
      "rrn": null,
      "arn": null,
      "approval_code": null,
      "reserved_amount": null,
      "reserve_expires": null,
      "unreserved": null,
      "source": "merchant_api",
      "callback_logs": [],
      "charged_back_amount": null,
      "charged_back": null,
      "resolution_message": null,
      "hpp_url": "https://api.example.com/redirect/hpp/?cpi=cpi_SjNNO234QGsq",
      "refunds": [],
      "reserves": [],
      "reserve_options": null,
      "processed_unreserve": null,
      "processed_reserve_cancel": null,
      "reserve_cancelled": null
    },
    "relationships": {
      "payment-service": {
        "data": {
          "type": "payment-services",
          "id": "bank_transfer_try_hpp"
        }
      },
      "payment-method": {
        "data": {
          "type": "payment-methods",
          "id": "bank_transfer"
        }
      },
      "customer": {
        "data": {
          "type": "customers",
          "id": "cus_uA03n345345M8DG"
        }
      },
      "active-payment": {
        "data": {
          "type": "payments",
          "id": "pay_Nn5Sv345345W3q5ova3"
        }
      }
    },
    "links": {
      "self": "/api/payment-invoices/cpi_SjNN34g343434sq"
    }
  }
}

Modified at 2024-11-27 14:16:29

CSV

Bank Transfers - Turkey (Invoice Initiation)