Sign in

v1

latestOpenAPI 3.1.02026-07-26490301.4 KB
Payment

Server-to-server

post/payment

Headers

X-Request-IDstring

Unique ID of request

Request body

metadataobject

Use to store additional information associated with the payment. You can add parameters <b>udf1</b> and <b>udf2</b> to pass your internal values such as transactionId, chargeId, orderId, bundleId, or affiliateId. Any values passed will be available in the Merchant Portal

Example request

{
  "paymentSource": {
    "type": "card",
    "number": "4024007179366348",
    "expirationMonth": "11",
    "expirationYear": "22",
    "cvv": "100",
    "3ds": false
  },
  "sku": {
    "title": "Product name",
    "siteId": "983759353",
    "price": [
      {
        "offset": "0d",
        "amount": 19.99,
        "currency": "USD",
        "repeat": false
      }
    ]
  },
  "consumer": {
    "id": "4242522",
    "email": "jonny.sonny@google.com",
    "firstName": "John",
    "lastName": "Doe",
    "phone": "+1987353539",
    "country": "USA",
    "state": "Alabama",
    "city": "Montgomery",
    "zip": "36101",
    "ip": "8.8.8.8",
    "userAgent": "mozilla/5.0 (iphone; cpu iphone os 13_1_2 like mac os x) applewebkit/605.1.15 (khtml, like gecko) version/13.0.1 mobile/15e148 safari/604.1",
    "deviceId": "1.1|hfp9sLiKhAoWyNSMpiQGh|mozilla/5.0 (windows nt 6.1) applewebkit/537.36 (khtml, like gecko) chrome/92.0.4515.131 safari/537.36|24#1344#840#799|internal-pdf-viewer#mhjfbmdgcfjbbpaeojofohoefgiehjai#internal-nacl-plugin|Win32|1g0u1g01u0u10r1u0x10g1y0g1d0g10g1010u101g0g1u01r0x10x101g01a010u101g01010u101r01z01ij01a0u1u01rd01r0r101ir01ii01aj01ux01ui01iy01y01ui0g1y01r01d0|MS|-1397920487|c39b35be"
  },
  "url": {
    "ipnUrl": "https://google.com/gateway/webhook/245252525252525",
    "redirectUrl": "https://google.com/gateway/redirect/245252525252525"
  },
  "metadata": {
    "foo": "bar"
  },
  "emailOptions": {
    "send": true
  }
}

Response

Created

metadataobject

Use to store additional information associated with the payment. You can add parameters <b>udf1</b> and <b>udf2</b> to pass your internal values such as transactionId, chargeId, orderId, bundleId, or affiliateId. Any values passed will be available in the Merchant Portal

Example response

{
  "payment": {
    "description": "APPROVED",
    "action": "charge",
    "url": "https://google.com/oijhflsfs9",
    "qrCode": "00020126910014BR.GOV.BCB.PIX2569api-pix-h.bancobs2.com.br/spi/v2/f8f7bd5e-d40a-40d1-ac98-4ec534c1bfc652040000530398654045.945802BR5925Visconde Pagamentos E Sol6014Belo Horizonte61083038040362070503***6304E381",
    "mode": "sale",
    "status": "success",
    "amount": 9.99,
    "currency": "USD",
    "amountUsd": 9.99,
    "orderId": "235324530",
    "transactionId": "12345",
    "descriptor": "centrohelp.com",
    "source": {
      "method": "card",
      "number": "402400****6348",
      "brand": "visa",
      "bankName": "BENDIGO AND ADELAIDE BANK, LTD",
      "bankCountry": "AUS",
      "paymentAccountId": "d86bdcbb-c369-46d9-a9d0-9c5010e3bfdb"
    }
  },
  "consumer": {
    "externalId": "14253ms92m0as",
    "email": "jonny.sonny@google.com",
    "phone": "+1987654320",
    "country": "GBR",
    "zip": "36101"
  },
  "subscription": {
    "status": "active",
    "renewalDate": "2020-04-17 13:43:02",
    "cancelDate": "2020-11-17 13:43:02"
  },
  "metadata": {
    "foo": "bar"
  },
  "timestamp": {
    "dateTime": "2020-04-17 13:43:02",
    "timezone": "UTC+02.00",
    "unixTime": "1637063718"
  }
}