Server2Server

Deposit with card information (Server2Server)

1

Create a deposit request to our PCI endpoint

The deposit request must include the credit_card[] object containing all the card details.

Note that the default response of this endpoint in synchronous.

Example request

curl -L \
  --request POST \
  --url 'https://cc-api-stg.onekeypayments.com/v3/deposits' \
  --header 'Content-Type: application/json' \
  --header 'X-Date: 2025-07-15T12:57:14.936Z' \
  --header 'X-Login: text' \
  --header 'Authorization: text' \
  --data '{
    "invoice_id": "800000001",
    "amount": 1000,
    "country": "BR",
    "currency": "BRL",
    "payer": {
      "id": "11111",
      "document": "84932568207",
      "document_type": "CPF",
      "email": "[email protected]",
      "first_name": "John",
      "last_name": "Smith"
    },
    "credit_card": {
      "cvv": "123",
      "number": "4111111111111111",
      "expiration_month": "10",
      "expiration_year": "25",
      "holder_name": "JOHN SMITH"
    },
    "client_ip": "123.123.123.123"
  }'

Example response

2

Retrieve the Deposit final status

Even though that this endpoint is mostly synchronous, we may eventually send webhooks to notify changes within a deposit.

These webhook notifications contain the deposit_id for you to retrieve the status.

{
  "deposit_id": 300604089
}

For more information on this point visit Notifications.