Sign in

v1

latestOpenAPI 3.1.02026-07-26490301.4 KB
Subscription

Change payment account for subscription

put/subscription/{id}/paymentAccount

Path parameters

idstring required

Gateway subscription ID

Headers

X-Request-IDstring

Unique ID of request

Request body

Example request

{
  "paymentSource": {
    "emulateCode": "5003",
    "mpiParameters": {
      "authStatus": "Y",
      "cavv": "kBMSV/fB8ausrgK8Xem8wIQBeP88",
      "eci": "02",
      "directoryServerTransactionId": "3ba1f2c9-613b-4c00-80b1-ec8869690b26",
      "scaExemption": "lowValue"
    }
  },
  "consumer": {
    "externalId": "14253ms92m0as",
    "email": "jonny.sonny@google.com",
    "phone": "+1987654320",
    "country": "GBR",
    "zip": "36101"
  }
}

Response

OK

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"
  }
}