v1

latestOpenAPI 3.0.3Apache License Version 2.02026-07-2631211285.4 KB

Availability Services

Availability

You can use this service to check if the customer is eligible for the "buy now pay later" payment method. The service will return the installment options in case of success. It is available for transparent checkout only.

post/v1/payment/orders/availability

Headers

Content-Typestring required

The Media type of the body of the request. Default value for payment provider protocol is application/json

Acceptstring required

Acceptable media type(s) for the response. Default value for payment provider protocol is application/json

Request body

country_codestring required

Transaction country code (two-letter ISO 3166 country code)

channel'API' | 'CHECKOUT' | 'LINK' | 'SDK'

Integration channel used to process the payment. If omitted in the request, it is assigned automatically based on the payment method and merchant account configuration.

ip_addressstring required

Buyer ip address

device_fingerprintstring required

Represents the device used to initiate the payment

Example request

{
  "store": {
    "code": "SBXSTORE"
  },
  "transaction": {
    "reference_id": "REF0000001",
    "business_id": "BIZ0000001",
    "account": "SBX000",
    "amount": {
      "currency_code": "BRL",
      "value": 1500.56
    }
  },
  "country_code": "BR",
  "channel": "API",
  "payment_method": {
    "code": "BNPL"
  },
  "payer": {
    "document": {
      "number": "54672396002"
    },
    "email": "jhon_doe@domain.com"
  },
  "ip_address": "192.0.2.146",
  "device_fingerprint": "3f139f92d30d54f1aaf519b3a39a20814",
  "items": [
    {
      "category": {
        "id": "111",
        "name": "Some category name"
      },
      "discount_amount": {
        "currency_code": "USD",
        "value": 8008.99
      },
      "id": "13238487",
      "name": "Some name",
      "price": {
        "currency_code": "USD",
        "value": 8008.99
      },
      "quantity": 5,
      "seller_id": "Some Seller",
      "service_date": "2021-10-23T10:00:00.307062Z",
      "type": "Generic"
    }
  ]
}

Response

Availability

country_codestring required

Transaction country code.

codestring

Standardized error code (applies only for error cases)

messagestring

Message associated with the error code (applies only for error cases)

Example response

{
  "store": {
    "code": "SBXSTORE"
  },
  "transaction": {
    "reference_id": "REF0000001",
    "business_id": "BIZ0000001",
    "account": "SBX000",
    "amount": {
      "currency_code": "BRL",
      "value": 1500.56
    }
  },
  "payment_method": {
    "code": "BNPL"
  },
  "country_code": "BR",
  "payer": {
    "document": {
      "number": "54672396002"
    },
    "email": "jhon_doe@domain.com"
  },
  "installment_options": [
    {
      "installments": 2,
      "installment_rate": 2.99,
      "installment_amount": 51.5,
      "total_amount": 103,
      "first_due_date": "2022-01-28T00:00:00.000Z",
      "iof": 26.18,
      "cet": 58.17,
      "cet_am": 3.84,
      "option_id": "28567e07-7296-41e7-99f1-e18df9756392",
      "incoming_percent_value": 1.2,
      "incoming_value": 10.44
    }
  ]
}