Skip to content

APM - TRY deposits by Papel (Gateway5)#

Alternative payment methods: deposit by Papel TRY transfer

Brief#

In order to create a Fixed Rate Invoice in the payment processing system, you need to make a POST request to the v2/invoices API endpoint.

POST https://api.xgateway.tech/api/v2/invoices
TRY Papel deposits 
{
    "customerId": "test-try-customer",
    "orderId": "test-try-order",
    "baseCurrency": "TRY",
    "amount": 1000,
    "paymentMethod": "papel",
    "paymentCurrency": "TRY",
    "customerFullName": "John Doe"
}

See the Alternative payment methods using Checkout page for the full OpenAPI specification.

The default lifetime of an invoice is 15 minutes.

Our local partners for Alternative Payment Methods may block customers using VPNs. It is generally recommended to warn customers that a payment method cannot be accessed through a VPN.

Details#

Validating limits#

The invoice creation API validates the amount value. The minimum and maximum amount values may differ based on the payment provider used for each specific invoice.
TRY Papel deposits (Gateway5) uses these:

Currency Min value Max value Increment step
TRY 1 000.00 250 000.00 50.00

For Papel the amount must be a multiple of 50 (example: 1150, 1200, 1250 TRY etc.)

Contact the support team if you want to confirm the limits.

Required payload#

Parameter Mandatory Description
amount true Requested amount. String or Number, in d+(.d+)? format. Limits applied
customerId true Customer id in the merchant system
baseCurrency true String representation of the requested currency. TRY in this case
orderId false Invoice id in the merchant system. If provided, used as an idempotency key
paymentMethod true String representation of the payment method. papel in this case
paymentCurrency false String representation of the payment currency. TRY in this case
customerFullName false Customer's full name

Ensure that no additional parameters, except those specified above, are passed into the invoice creation request.

Payload examples#

The system will skip all XGateway intermediate pages and redirect the customer directly to the payment method only if all required data is provided.

TRY Papel deposits

Full payload to create and activate an invoice (opens the payment method directly): 

{
    "customerId": "test-try-customer",
    "orderId": "test-try-order",
    "baseCurrency": "TRY",
    "amount": 1000,
    "paymentMethod": "papel",
    "paymentCurrency": "TRY",
    "customerFullName": "John Doe"
}

If you get a bad request response without exact information about the erroneous field, please check the syntax of the request.

API Response#

After a successful call, you will receive a 201 - Created response with a link to a Checkout page configured according to your request. 

{
  "data": "https://checkout.xgateway.tech/ff36a7a5-08fd-418a-a150-f6f2d36676a8",
  "success": true
}

The Checkout page will prompt the customer for any data missing from the initial request that is required to create an invoice.

Once all required data is provided, the Checkout page will redirect the customer to the local payment system (Papel).