v1

latestOpenAPI 3.0.02026-08-069911.6 KB

Create a payment

Endpoint to create a Payment.

post/v2/payments

Request body

companyIdstring

referencestring

amountstring

currencystring

Example request

{
  "companyId": "123456",
  "reference": "055810100345",
  "amount": "100.00",
  "currency": "MXN"
}

Response

Successfully created payment

idstring

customerBillIdstring

companyIdstring

referencestring

amountstring

currencystring

statusstring

authNumberstring

ticketMessagestring

metadataobject

createdAtstring date-time

Example response

{
  "id": "123456789000",
  "customerBillId": "123456789012",
  "companyId": "00012345679",
  "reference": "055810100345",
  "amount": "100.0",
  "currency": "MXN",
  "status": "COMPLETED",
  "authNumber": "123456789012",
  "ticketMessage": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Mauris pellentesque venenatis odio, ut varius lacus. Fusce vel ullamcorper turpis. Suspendisse eu turpis a leo porta porta",
  "metadata": {},
  "createdAt": "2024-04-10T19:48:43.222Z"
}