PagedPaymentResponse

meta objectrequired

meta data

skipnumber

number of skip records

Default value: 0

Example: 0

limitnumber

number of maximum return records

Default value: 10

Example: 10

totalCountnumberrequired

total number of records

Example: 100

timestampstring<date-time>required

the time of the query result

data object[]required

records

Array [

clientIdstring

ID of the client to which the payment belongs

Example: 401f4647-8372-495f-8de0-aafb3e1eaf93

currencyCodestringrequired

Three letters payment currency code

Possible values: <= 3 characters

Example: USD

sellCurrencyCodestring

Three letters sell currency code if FX included

Possible values: <= 3 characters

Example: AUD

quotationIdstring

Quatation id if FX included

amountnumber<double>required

Payment amount on payment currency

Possible values: >= 1

Example: 10000

chargeTypePaymentChargeTypesrequired

Payment charge type if it is a swift payment

Possible values: [SHARED, OURS]

Example: SHARED

paymentReferencestringrequired

Payment Reference. Allowed characters: letters, digits, spaces and / - ? : ( ) . , ' +

Possible values: <= 64 characters, Value must match regular expression ^[a-zA-Z0-9/\-?:().,'+ ]+$

Example: Invoice-123

paymentDatestringrequired

Payment date (in formart YYYY-MM-DD)

Example: 2024-07-30

purposeCodePaymentPurposeCodesrequired

Purpose code of the payment

Possible values: [DEBT, FAMILY, GOODS, SERVICES, HIGH_VALUE_ITEM, INVESTMENT, SAVING, COMPANY_MANAGE, INTER_GROUP_TRANSFER, FREIGHT]

Example: GOODS

sourceOfFundsPaymentFundSourceTypes

Source of payment fund. Conditionally required: Required for (1) local payments, or (2) POBO SWIFT payments to personal beneficiaries. Optional for other payment types.

Possible values: [Salary, Savings, Loan, Business Income]

Example: Business Income

invoiceNumberstring

Invoice number, Conditionally required: Required for local INR payments to business beneficiaries. Allowed characters: letters, digits and - _ /

Possible values: <= 32 characters, Value must match regular expression ^[A-Za-z0-9\-_/]+$

invoiceDatestring

Invoice date for the payment (in formart YYYY-MM-DD), Conditionally required: Required for local INR payments to business beneficiaries.

Example: 2024-06-30

referenceIdobject<^[a-zA-Z0-9_][a-zA-Z0-9_-]{0,35}$>nullable

The unique reference id of payment creation. Optional, but highly recommended to use. When given, it fails the creation if a duplicate payment is found. Only alphanumeric characters, underscores and hyphens are allowed, and cannot start with a hyphen.

Possible values: <= 36 characters

Example: 1234567890

beneficiaryIdstringrequired

Id of beneficiary

Possible values: <= 36 characters

idstringrequired

id of the payment

Example: 401f4647-8372-495f-8de0-aafb3e1eaf93

referenceNostringrequired

Human readable payment reference No

Example: 20240726-PA8JZ4

chargeFeenumberrequired

Charge fee in payment currency

Example: 10

sellAmountnumber

Payment sell amount if FX included

Example: 15000

exchangeRatenumber

Payment foreign exchange rate if FX included

Example: 0.66667

currencyPairstring

Payment foreign exchange currency pair if FX included

Example: AUDUSD

statusPaymentStatusesrequired

Status of the payment

Possible values: [PENDING APPROVAL, SCHEDULED, WAITING FUNDS, SENDING, COMPLETED, CANCELLED, FAILED, REJECTED]

Example: SCHEDULED

createdTimestringrequired

The time when the payment was created

Example: 2023-12-12T01:23:33Z

updatedTimestringrequired

The time when the payment was last updated

Example: 2023-12-12T01:23:33Z

failureReasonstringnullable

The reason of payment failed

Example: Beneficiary name mismatch

]

PagedPaymentResponse

{
  "meta": {
    "skip": 0,
    "limit": 10,
    "totalCount": 100,
    "timestamp": "2024-07-29T15:51:28.071Z"
  },
  "data": [
    {
      "clientId": "401f4647-8372-495f-8de0-aafb3e1eaf93",
      "currencyCode": "USD",
      "sellCurrencyCode": "AUD",
      "quotationId": "string",
      "amount": 10000,
      "chargeType": "SHARED",
      "paymentReference": "Invoice-123",
      "paymentDate": "2024-07-30",
      "purposeCode": "GOODS",
      "sourceOfFunds": "Business Income",
      "invoiceNumber": "string",
      "invoiceDate": "2024-06-30",
      "referenceId": "1234567890",
      "beneficiaryId": "string",
      "id": "401f4647-8372-495f-8de0-aafb3e1eaf93",
      "referenceNo": "20240726-PA8JZ4",
      "chargeFee": 10,
      "sellAmount": 15000,
      "exchangeRate": 0.66667,
      "currencyPair": "AUDUSD",
      "status": "SCHEDULED",
      "createdTime": "2023-12-12T01:23:33Z",
      "updatedTime": "2023-12-12T01:23:33Z",
      "failureReason": "Beneficiary name mismatch"
    }
  ]
}