Create card charge

curl --request POST \
  --url https://app.amplopay.com/api/v1/gateway/card/receive \
  --header 'Content-Type: application/json' \
  --header 'x-public-key: SUA_CHAVE_PUBLICA_AQUI' \
  --header 'x-secret-key: SUA_CHAVE_PRIVADA_AQUI' \
  --data '{
    "identifier": "card-123",
    "amount": 197,
    "installments": 3,
    "client": {
      "name": "João da Silva",
      "email": "joao@email.com",
      "phone": "(11) 99999-9999",
      "document": "123.456.789-00"
    },
    "clientIp": "127.0.0.1",
    "card": {
      "number": "4111111111111111",
      "owner": "JOAO DA SILVA",
      "expiresAt": "2030-12",
      "cvv": "123",
      "statementDescriptor": "MINHA LOJA"
    },
    "callbackUrl": "https://example.com/webhooks/payment"
  }'

{
  "transactionId": "transaction_id",
  "status": "OK",
  "fee": 10.5,
  "order": {
    "id": "order_id",
    "url": "https://app.amplopay.com/order/order_id"
  }
}

POST

gateway

card

receive

curl --request POST \
  --url https://app.amplopay.com/api/v1/gateway/card/receive \
  --header 'Content-Type: application/json' \
  --header 'x-public-key: SUA_CHAVE_PUBLICA_AQUI' \
  --header 'x-secret-key: SUA_CHAVE_PRIVADA_AQUI' \
  --data '{
    "identifier": "card-123",
    "amount": 197,
    "installments": 3,
    "client": {
      "name": "João da Silva",
      "email": "joao@email.com",
      "phone": "(11) 99999-9999",
      "document": "123.456.789-00"
    },
    "clientIp": "127.0.0.1",
    "card": {
      "number": "4111111111111111",
      "owner": "JOAO DA SILVA",
      "expiresAt": "2030-12",
      "cvv": "123",
      "statementDescriptor": "MINHA LOJA"
    },
    "callbackUrl": "https://example.com/webhooks/payment"
  }'

{
  "transactionId": "transaction_id",
  "status": "OK",
  "fee": 10.5,
  "order": {
    "id": "order_id",
    "url": "https://app.amplopay.com/order/order_id"
  }
}

Processes a card payment.

Body parameters

string

required

Unique identifier for this transaction in your application.

number

required

Transaction amount in BRL.

number

Number of card installments.

string

required

IPv4 of the customer performing the transaction.

object

required

Customer information, including address when required by the card processor.

string

required

Customer full name.

string

required

Customer email address.

string

required

Customer phone number.

string

required

Customer document, such as CPF or CNPJ for Brazilian customers.

object

required

Customer billing address.

string

required

Customer country code, such as BR.

string

required

Customer ZIP code.

string

required

Customer state code, such as SP.

string

required

Customer city.

string

required

Customer street.

string

required

Customer neighborhood.

string

required

Customer address number.

string

Customer address complement.

object

required

Card data used to process the payment.

string

required

Cardholder name.

string

required

Card number.

string

required

Card expiration date in YYYY-MM format.

string

required

Card security code.

string

Statement descriptor displayed on the card charge.

string

URL that will receive payment status webhook notifications.

array

Products included in the transaction.

string

required

Product identifier in your application.

string

required

Product name.

number

Product quantity.

number

required

Product unit price in BRL.

number

Shipping fee in BRL.

number

Additional fee in BRL.

number

Discount amount in BRL.

array

Payment split configuration.

string

required

Producer ID that will receive the split amount.

number

required

Amount sent to the split receiver, in BRL.

object

Free-form metadata associated with the transaction.

Request example

curl --request POST \
  --url https://app.amplopay.com/api/v1/gateway/card/receive \
  --header 'Content-Type: application/json' \
  --header 'x-public-key: SUA_CHAVE_PUBLICA_AQUI' \
  --header 'x-secret-key: SUA_CHAVE_PRIVADA_AQUI' \
  --data '{
    "identifier": "card-123",
    "amount": 197,
    "installments": 3,
    "client": {
      "name": "João da Silva",
      "email": "joao@email.com",
      "phone": "(11) 99999-9999",
      "document": "123.456.789-00"
    },
    "clientIp": "127.0.0.1",
    "card": {
      "number": "4111111111111111",
      "owner": "JOAO DA SILVA",
      "expiresAt": "2030-12",
      "cvv": "123",
      "statementDescriptor": "MINHA LOJA"
    },
    "callbackUrl": "https://example.com/webhooks/payment"
  }'

Payload example

{
  "identifier": "card-123",
  "amount": 197,
  "installments": 3,
  "client": {
    "name": "João da Silva",
    "email": "joao@email.com",
    "phone": "(11) 99999-9999",
    "document": "123.456.789-00",
    "address": {
      "country": "BR",
      "zipCode": "01304-000",
      "state": "SP",
      "city": "São Paulo",
      "street": "Rua Augusta",
      "neighborhood": "Consolação",
      "number": "6312",
      "complement": "6 andar"
    }
  },
  "clientIp": "127.0.0.1",
  "card": {
    "number": "4111111111111111",
    "owner": "JOAO DA SILVA",
    "expiresAt": "2030-12",
    "cvv": "123",
    "statementDescriptor": "MINHA LOJA"
  },
  "callbackUrl": "https://example.com/webhooks/payment"
}

Response

string

required

Transaction ID generated by the Gateway API.

string

required

Initial transaction status.

number

required

Transaction fee amount.

object

required

Order information and hosted order URL.

{
  "transactionId": "transaction_id",
  "status": "OK",
  "fee": 10.5,
  "order": {
    "id": "order_id",
    "url": "https://app.amplopay.com/order/order_id"
  }
}

⌘I

Getting started

Endpoints

Webhooks

FAQ

Create card charge

Body parameters

Request example

Payload example

Response

​Body parameters

​Request example

​Payload example

​Response

Body parameters

Request example

Payload example

Response