API Reference
Log In
API Reference

Retrieves the details for a single pay run. This will include all of the constituent batches, groups and
payables. Each constituent entity will have a status which you can use to determine the current status of
any payment attempt.

Payable Properties

  • fundingAmount - Represents the amount being debited from the payer's bank account when this payable is processed
    • May or may not include the fees of this payable, depending how the fee is charged
  • endUserTotalCostAmount - Represents the full cost of paying this payable when this and any associated fee payables are processed
  • $type - Payable (which you supplied) or FeePayable (which Crezco added if necessary)

Fees

See Collecting Fees

Currency Conversion

International payables have a currencyConversion object. This describes the rate associated with sending that payment internationally.

  • isEstimated - true if the rates are estimated, false if the rate has been confirmed and locked in
  • rate - The exchange rate used for this Payable, exclusive of all fees

Reversed Payables

Sometimes when an international payment fails to deliver, it must be reversed and sent back to the payer. Depending on how far through processing a payment was when it failed, it could incur bank charges or losses in converting back to the funding currency, and the funds returned may be less than the funds sent.

When the status of a Payable is Reversed then the amount returned will be given in an reversedAmount object. This contains the amount returned in minor units (amountInMinorUnits) and the ISO 4217 currency code (currencyCode).

Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!