Payment Requests
Create Payment Request
Creates a new Payment Request from the information sent in the body.
POST
/
paymentRequests
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Body
application/json
paymentMethodId
string
requiredUnique identifier of the payment method.
amount
number
requiredAmount to be charged.
Response
201 - application/json
id
string
Unique identifier for this payment request.
status
enum<string>
Current status of the payment request.
Available options:
pending
, processing
, approved
, error
customerId
string
Reference to the customer who owns the payment method from which the payment request was created.
customerDetails
object
paymentMethodId
string
Reference to the payment method from which the payment request was created.
paymentMethodDetails
object
currency
string
Always "cop" (Colombian Pesos).
amount
number
Amount to collect from the customer's payment method, with no more than two decimal places.
createdAt
string
ISO string when the payment request was created.
updatedAt
string
ISO string when the payment request was last updated.
approvedDetails
object
errorDetails
object