CreatePaymentsRequest

Request for creating payments

payments object[]required

List of payment properties for creating payments

Possible values: >= 1

Array [

externalIdstringrequired

External ID of the payment

Possible values: non-empty

Example: EXT123

quoteIduuidrequired

Quote ID associated with the payment

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

amount objectrequired

Amount of the payment

amountnumberrequired

The specific monetary value that is being converted from in the currency exchange

Example: 100

currencystringrequired

The type of currency that the money is being exchanged from

Possible values: non-empty, Value must match regular expression [A-Z]{3}

Example: USD

referencestringrequired

Reference for the payment

Possible values: non-empty

Example: REF123

purposeOfPaymentstringrequired

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]

beneficiaryIduuidrequired

Beneficiary ID associated with the payment

Example: 3fa85f64-5717-4562-b3fc-2c963f66afa6

documentReferencestring

Document reference associated with the payment

Example: DOC123

document object

Document associated with the payment

mediaTypestringrequired

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

Example: application/pdf

namestringrequired

The name of the file, including the file extension

Possible values: non-empty

Example: document.pdf

]

CreatePaymentsRequest

{
  "payments": [
    {
      "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"
      }
    }
  ]
}