Skip to main content

Get a payment

GET 
/api/v1/payments/:id

Retrieve a single payment by id

Request​

Path Parameters

    id stringrequired

Header Parameters

    ApiKey stringrequired
    AccountId stringrequired

Responses​

OK

Schema
    id uuidrequired

    Unique identifier for the payment

    status object

    Status of a payment

    state stringrequired

    Possible values: [DRAFT, CANCELLED, PENDING_APPROVAL, DUE, PAID]

    The state of a payment

    reason string

    The reason for the status of a payment

    complete boolean

    Payment status

    createdAt date-timerequired

    Creation time of the payment

    completedAt date-time

    Completion time of the payment

    externalId stringrequired

    External ID of the payment

    quoteId uuidrequired

    Quote ID associated with the payment

    amount objectrequired
    amount numberrequired

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

    currency stringrequired

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

    The type of currency that the money is being exchanged from

    reference stringrequired

    Reference for the payment

    purposeOfPayment stringrequired

    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]

    Purpose of the payment

    beneficiaryId uuidrequired

    Beneficiary ID associated with the payment

    documentReference string

    Document reference associated with the payment

    document object

    Receipt file in Base64-encoded format

    mediaType stringrequired

    The MIME type of the file, such as 'application/pdf' for a PDF file or 'image/jpeg' for a JPEG image

    name stringrequired

    The name of the file, including the file extension

Loading...