Deposit creation endpoint

Learn how to create deposits with QuickPay

The QuickPay solution uses the same integration of our Deposits API endpoints with the difference that you don't need to send us most of the payer[] object (the customer details) on the Deposit creation API since this information is not required.

Note: For MEXICO SPEI payments, the payer object needs to be included with only an "id", which is NOT the document of the customer, it is the unique reference for the payer within the merchant's system. payer[] object is not mandatory for PIX Brasil.

Hence, requests must not contain any payer info. Please take a look at the following example request and follow the details on Deposit Creation Endpoint for further details about the integration.

OneShot Request example

Example Brasil

{
    "invoice_id" : "1000000001",
    "amount": "1000",
    "country": "BR",
    "currency": "BRL",
    "payment_method": "IX",
    "description": "test description",
    "client_ip": "123.123.123.123",
    "device_id": "00000000-00000000-01234567-89ABCDEF",
    "notification_url": "https://www.onekeypayments.com/OKP/notify",
    "test": false,
    "mobile": true,
    "language": "pt"
}