Sign in

v1

latestOpenAPI 3.1.02026-07-2479154362.5 KB
Payment Intent

Create payment intent

Create payment intent

post/api/v1/payment-intent/

Request body

product_idstring uuid required

Identifies a product, it can be a Widget or other product type

product_type'widget'
external_idstring uuid nullable

An external ID to identify a user. It can be the merchant's user ID or other tracking ID

conceptstring nullable

Concept associated with the payment intent. This text will be reflected as a concept in the bank issuing the payment

currencystring required

Currency associated with the amount of the payment intent

amountstring decimal required

Amount to be charged to a payment intent

usernamestring nullable

The payer username in the merchant store

document_numberstring nullable

The document number of the payer with which you are registered in the merchant's store

referencestring nullable

Reference associated with the payment intent

Example request

{
  "product_id": "0daf107a-2aa2-4661-a0ea-e7cf4ad2730c",
  "external_id": "bf5d88cc-f60c-4612-8739-15b3244fcd04",
  "concept": "PROM123452 REF45424322",
  "currency": "USD",
  "amount": "1.00",
  "username": "jdoe",
  "document_number": "8.410.692-1",
  "reference": "Ticket 5841205-B"
}

Response

Payment intent created

intent_idstring uuid required
external_idstring uuid nullable

An external ID to identify a user. It can be the merchant's user ID or other tracking ID

conceptstring nullable

Concept associated with the payment intent. This text will be reflected as a concept in the bank issuing the payment

currencystring required

Currency associated with the amount of the payment intent

amountstring decimal required

Amount to be charged to a payment intent

usernamestring nullable

The payer username in the merchant store

document_numberstring nullable

The document number of the payer with which you are registered in the merchant's store

referencestring nullable

Reference associated with the payment intent

Example response

{
  "intent_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "external_id": "bf5d88cc-f60c-4612-8739-15b3244fcd04",
  "concept": "PROM123452 REF45424322",
  "currency": "USD",
  "amount": "1.00",
  "username": "jdoe",
  "document_number": "8.410.692-1",
  "reference": "Ticket 5841205-B"
}