Payment
Payment details
Unique identifier for the payment
3fa85f64-5717-4562-b3fc-2c963f66afa6
status object
Status of a payment
State of the payment
Possible values: [DRAFT
, CANCELLED
, PENDING_APPROVAL
, DUE
, PAID
]
Reason for the payment status
Payment status
false
Creation time of the payment
2023-01-01T00:00:00Z
Completion time of the payment
2023-01-01T00:00:00Z
External ID of the payment
Possible values: non-empty
EXT123
Quote ID associated with the payment
3fa85f64-5717-4562-b3fc-2c963f66afa6
amount objectrequired
Amount of the payment
The specific monetary value that is being converted from in the currency exchange
100
The type of currency that the money is being exchanged from
Possible values: non-empty
, Value must match regular expression [A-Z]{3}
USD
Reference for the payment
Possible values: non-empty
REF123
Purpose of the payment
Possible values: [COMPUTER_SERVICES
, FAMILY_SUPPORT
, EDUCATION
, MEDICAL_TREATMENT
, MAINTENANCE_EXPENSES
, TRAVEL
, SMALL_VALUE_REMITTANCE
, CONSTRUCTION_EXPENSES
, HOTEL_ACCOMMODATION
, ADVERTISING_EXPENSES
, ADVISORY_FEES
, BUSINESS_INSURANCE
, INSURANCE_CLAIMS
, DELIVERY_FEES
, EXPORTED_GOODS
, SERVICE_CHARGES
, LOAN_PAYMENT
, OFFICE_EXPENSES
, PROPERTY_PURCHASE
, PROPERTY_RENTAL
, ROYALTY_FEES
, SHARES_INVESTMENT
, FUND_INVESTMENT
, TAX_PAYMENT
, TRANSPORTATION_FEES
, UTILITY_BILLS
, PERSONAL_TRANSFER
, SALARY_PAYMENT
, INFLUENCER_PAYMENT
, DIVIDEND_PAYMENT
, OTHER_FEES
, OTHER
]
Beneficiary ID associated with the payment
3fa85f64-5717-4562-b3fc-2c963f66afa6
Document reference associated with the payment
DOC123
document object
Document associated with the payment
The MIME type of the file, such as 'application/pdf' for a PDF file or 'image/jpeg' for a JPEG image
Possible values: non-empty
application/pdf
The name of the file, including the file extension
Possible values: non-empty
document.pdf
Payment properties object
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": {
"state": "DRAFT",
"reason": "string",
"complete": false
},
"createdAt": "2023-01-01T00:00:00Z",
"completedAt": "2023-01-01T00:00:00Z",
"externalId": "EXT123",
"quoteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"amount": {
"amount": 100,
"currency": "USD"
},
"reference": "REF123",
"purposeOfPayment": "COMPUTER_SERVICES",
"beneficiaryId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"documentReference": "DOC123",
"document": {
"mediaType": "application/pdf",
"name": "document.pdf"
}
}