Execute a payment to a transaction.

❗️

Confirm that you have a postbackUrl configured

In order to receive a notification for a status update, please, make sure you have a postback URL configured to your whitelabel, or that you are sending one using the attribute postbackUrl.

🚧

Transaction Status

Both approved or declined transactions will return the same "Single Transaction" return body. In case of declined transactions, the return body will retrieve all the details about why the transaction was declined.

Post Body Example

{
  "method": "creditCard",
  "document": "44774339806",
  "softDescriptor": "Ingresse",
  "acquirer": "cielo",
  "postbackUrl": "https://domain.com/postback",
  "creditCard": {
    "installments" : 1,
    "number" : "4111111111111111",
    "holder" : "john doe",
    "expiration" : "09/29",
    "cvv" : "332"
  },
  "customer": {
    "externalId": "1",
    "name": "john Doe",
    "address": {
      "street": "Rua Joaquim Floriano",
      "number": 820,
      "district": "New Places",
      "zipcode": "123456789",
      "city": "Sao Paulo",
      "state": "SP",
      "country": "BR"
    }
  },
  "capture": false,
  "antifraudData": {
    "ip" : "127.0.0.1",
    "collector": "lkdjhfasdqwerflskjoxcvuzpoicvuzpxoivuhlskdjfhlaskjdfhals",
    "deviceCollector": "gNhOXDw4ARfPn4dyR2f0j_yCAASlbfQJg5UqWbQdCEK1uHTZYfWNerHFRnrW4XfskMFDXWz8TpROivEq831kQuQ_CwPh2ZYGJPoxDPrIa4zXv660ZvTemTlmqFimSpcVy67qoGUZFz_AbuLLJ7ZUmPUkRYn8c7xtIeMrni9hYKmPmrWTd2m48H44K6q7pHBv01nUmisBrvyMp4iWaXcclIwRFcYzYHcNDtVnOtar4q150UFWKsQ9inJzuGD838WJA_JeB0yDMI4roz3AiA5lcm0i8cj_HxsN7ukljEXMlk-Q75HlPBu74ZOZspZXCb4v_INEkT0WSSqSnvQsBybDNu-RkW9bNAG71t6yqWG2hnJ9Fn_GCcLeklg3fbzwOAEdTcTgB9hLaRYQrbmvO9l22PPExynHiqu8QAAj0DCrE2TlCBHo4sofpzVXiHnYSbMql4nzOKgMYyfX7J",
    "browserHeaders": [{
      "key": "user-agent",
      "value": "Mozilla/5.0"
    }],
    "source": "web",
    "event": {
      "id": "34k5jh345",
      "name": "Event title",
      "session": "2018-01-01 00:00:00"
    }
  }
}
{
    "method": "paypal",
    "document": "44774339806",
  	"paypal": {
    	"installments": 1,
    	"billingAgreement": "B-8MS90834NW474913D",
    	"payerId": "KRUAS85KLU3JA"
    },
    "customer": {
      "externalId": "1",
      "name": "john Doe",
      "address": {
          "street": "Rua Joaquim Floriano",
          "number": 820,
          "zipcode": "123456789",
          "city": "Sao Paulo",
          "state": "SP",
          "country": "BR"
      }
    },
    "capture": true
}
{
  "method": "bankBillet",
  "bankBillet": {
    "instructions": "Any recomendations to customer",
    "expiration": 3
  },
  "document": "44774339806",
  "customer": {
    "externalId": "1",
    "name": "john Doe",
    "address": {
      "street": "Rua Joaquim Floriano",
      "number": 820,
      "district": "New Places",
      "zipcode": "123456789",
      "city": "Sao Paulo",
      "state": "SP", 
      "country": "BR"
    }
  }
}
{
  "method": "creditCardToken",
  "document": "44774339806",
  "softDescriptor": "Ingresse",
  "acquirer": "cielo",
  "postbackUrl": "https://domain.com/postback",
  "creditCardToken": {
    "installments" : 1,
    "token" : "6aa0dd09-019a-41ee-9901-eef1e89e7ae7"
  },
  "customer": {
    "externalId": "1",
    "name": "john Doe",
    "address": {
      "street": "Rua Joaquim Floriano",
      "number": 820,
      "district": "New Places",
      "zipcode": "123456789",
      "city": "Sao Paulo",
      "state": "SP",
      "country": "BR"
    }
  },
  "capture": false,
  "antifraudData": {
    "ip" : "127.0.0.1",
    "collector": "lkdjhfasdqwerflskjoxcvuzpoicvuzpxoivuhlskdjfhlaskjdfhals",
    "deviceCollector": "gNhOXDw4ARfPn4dyR2f0j_yCAASlbfQJg5UqWbQdCEK1uHTZYfWNerHFRnrW4XfskMFDXWz8TpROivEq831kQuQ_CwPh2ZYGJPoxDPrIa4zXv660ZvTemTlmqFimSpcVy67qoGUZFz_AbuLLJ7ZUmPUkRYn8c7xtIeMrni9hYKmPmrWTd2m48H44K6q7pHBv01nUmisBrvyMp4iWaXcclIwRFcYzYHcNDtVnOtar4q150UFWKsQ9inJzuGD838WJA_JeB0yDMI4roz3AiA5lcm0i8cj_HxsN7ukljEXMlk-Q75HlPBu74ZOZspZXCb4v_INEkT0WSSqSnvQsBybDNu-RkW9bNAG71t6yqWG2hnJ9Fn_GCcLeklg3fbzwOAEdTcTgB9hLaRYQrbmvO9l22PPExynHiqu8QAAj0DCrE2TlCBHo4sofpzVXiHnYSbMql4nzOKgMYyfX7J",
    "browserHeaders": [{
      "key": "user-agent",
      "value": "Mozilla/5.0"
    }],
    "source": "web",
    "event": {
      "id": "34k5jh345",
      "name": "Event title",
      "session": "2018-01-01 00:00:00"
    }
  }
}
{
  "method": "pix",
  "pix": {
    "expiration": 1800
  },
  "document": "99999999999",
  "customer": {
    "externalId": "1",
    "name": "john Doe",
    "address": {
      "street": "Rua Joaquim Floriano",
      "number": 820,
      "district": "New Places",
      "zipcode": "123456789",
      "city": "Sao Paulo",
      "state": "SP", 
      "country": "BR"
    }
  }
}

Attributes Options

creditCardvisa, master, amex, elo, diners, discover, jcb, aura

Payment Postback Body Example

{
  "data": {
    "date": "2018-10-02 16:10:43.961839",
    "status": "refund",
    "transactionId": "7336E6FB50A211DACA7805A467E449141F27D5D3"
  },
  "timestamp": "2018-10-02T19:10:44Z",
  "webhook": "postback"
}
Language
Authorization
Query
Click Try It! to start a request and see the response here!