POST
/
paymentRequests
curl --request POST \
  --url https://prod.api.palomma.com/v1/paymentRequests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "paymentMethodId": "<string>",
  "amount": 123
}'
{
  "id": "0697129c-26e2-42f1-a000-dc60878d5588",
  "status": "approved",
  "customerId": "e79a0b74-3aba-4149-9f74-0bb5791a6ee6",
  "customerDetails": {
    "name": "Pepito Perez",
    "documentType": "cc",
    "documentNumber": "200220422",
    "email": "pepito@perez.com"
  },
  "paymentMethodId": "67d7ae28-bf1d-4ee9-8a47-99358c9e6c32",
  "paymentMethodDetails": {
    "type": "bankAccount",
    "bankAccount": {
      "bank": "santander",
      "accountType": "savings",
      "accountNumber": "123456789"
    },
    "bancolombiaInstant": {
      "affiliate": {
        "name": "Pepito Perez",
        "documentType": "cc",
        "documentNumber": "200220422",
        "accountType": "savings",
        "accountNumber": "123456789"
      }
    },
    "nequiInstant": {
      "phoneNumber": "3298779391"
    }
  },
  "currency": "cop",
  "amount": 10000,
  "createdAt": "“2023-10-26T21:28:34.152Z”",
  "updatedAt": "“2023-10-26T21:28:34.152Z”",
  "approvedDetails": {
    "status": "approved",
    "approvedAt": "2023-10-26T21:28:34.152Z",
    "paidAt": "2023-10-26T21:28:34.152Z"
  },
  "errorDetails": {
    "status": "error",
    "errorCode": "D23",
    "errorMessage": "Not enough funds",
    "errorAt": "“2023-10-26T21:28:34.152Z”"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
paymentMethodId
string
required

Unique identifier of the payment method.

​
amount
number
required

Amount to be charged.

Response

201
application/json
Payment Request created successfully.
​
id
string

Unique identifier for this payment request.

Example:

"0697129c-26e2-42f1-a000-dc60878d5588"

​
status
enum<string>

Current status of the payment request.

Available options:
pending,
processing,
approved,
error
Example:

"approved"

​
customerId
string

Reference to the customer who owns the payment method from which the payment request was created.

Example:

"e79a0b74-3aba-4149-9f74-0bb5791a6ee6"

​
customerDetails
object
​
paymentMethodId
string

Reference to the payment method from which the payment request was created.

Example:

"67d7ae28-bf1d-4ee9-8a47-99358c9e6c32"

​
paymentMethodDetails
object
​
currency
string

Always "cop" (Colombian Pesos).

Example:

"cop"

​
amount
number

Amount to collect from the customer's payment method, with no more than two decimal places.

Example:

10000

​
createdAt
string

ISO string when the payment request was created.

Example:

"“2023-10-26T21:28:34.152Z”"

​
updatedAt
string

ISO string when the payment request was last updated.

Example:

"“2023-10-26T21:28:34.152Z”"

​
approvedDetails
object
​
errorDetails
object