Skip to main content
POST
/
payments
Create payment
curl --request POST \
  --url https://api.prod.payana.cloud/public/api/v1/payments \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '
{
  "beneficiary_reference": "8b1895e2-5b13-4fa1-9633-382639b6d0e3",
  "amount": 10000,
  "amount_currency": "USD",
  "exchange_rate": 19,
  "exchange_currency": "USD",
  "file_path": "https://example.com/image.pdf",
  "payable_payload": {
    "expiration_date": "2025-01-01",
    "issue_date": "2025-01-01",
    "concept": "Payment of invoice 1234567890"
  }
}
'
{
  "reference": "8b1895e2-5b13-4fa1-9633-382639b6d0e3",
  "beneficiary": {
    "reference": "8b1895e2-5b13-4fa1-9633-382639b6d0e3",
    "name": "John Doe",
    "identifier_type": "NIT",
    "identifier_number": "1234567890",
    "is_deleted": true,
    "deleted_at": "2019-08-24T14:15:22Z"
  },
  "document": null,
  "amount": 10000,
  "amount_currency": "USD",
  "exchange_rate": 19,
  "exchange_currency": "USD",
  "status": "pending",
  "file_path": "https://example.com/image.jpg",
  "receipt_file_path": "https://example.com/image.jpg",
  "is_archived": false,
  "payable": {
    "reference": "8b1895e2-5b13-4fa1-9633-382639b6d0e3",
    "type": "advance",
    "status": "paid",
    "amount": 10000.65,
    "amount_currency": "USD",
    "file_path": "https://example.com/image.pdf",
    "balance": 10000.65,
    "issue_date": "2025-01-01",
    "expiration_date": "2025-01-01",
    "concept": "string",
    "origin": "document",
    "projects": []
  },
  "batch": null,
  "tags": [],
  "source_of_fund": null,
  "accounting_receipt": null,
  "paid_at": "2019-08-24T14:15:22Z",
  "payment_method": "cash",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.payana.la/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

api-key
string
header
required

API key provista por Payana.

Body

application/json

Payment payload

beneficiary_reference
string
required

Referencia (UUID) del beneficiario.

amount
integer
required
Required range: x >= 1
amount_currency
enum<string>
required
Available options:
USD,
COP,
MXN,
EUR
file_path
string<uri>
required
payable_payload
object
required
exchange_rate
number | null
exchange_currency
enum<string> | null
Available options:
USD,
COP,
MXN,
EUR

Response

Payment created

reference
string
beneficiary
object
email
string | null
document
object
amount
integer
amount_currency
enum<string>
Available options:
USD,
COP,
MXN,
EUR
exchange_amount
number | null
exchange_currency
enum<string> | null
Available options:
USD,
COP,
MXN,
EUR
exchange_rate
number | null
status
enum<string>
Available options:
pending,
scheduled,
processing,
paid,
failed,
refunded
file_path
string | null
receipt_file_path
string | null
is_archived
boolean
payable
object
batch
object
tags
string[]
source_of_fund
object
accounting_receipt
object
paid_at
string<date-time> | null
payment_method
string | null
created_at
string<date-time> | null
updated_at
string<date-time> | null