Outbound Payment Import Entry
Import Entries are the individual rows of an outbound payment import, representing each payment to be created.
List outbound payment import entries#
/outbound_payment_import_entriesReturns a cursor-paginated list of the entries for a given outbound payment import.
Query Parameters
| Name | Type | Description |
|---|---|---|
before | string | null | Cursor pointing to the end of the desired set. |
after | string | null | Cursor pointing to the start of the desired set. |
limit | integer | string | Number of records to return. |
outbound_payment_import | stringrequired |
Response 200
Successful response
outbound_payment_import_entriesarray10 properties
idstring
Unique identifier, beginning with "IE".
created_atstring
Fixed timestamp, recording when this resource was created.
processed_atstring | null
Fixed timestamp, recording when this entry was processed.
amountinteger | null
Amount, in the lowest denomination for the currency (e.g. pence in GBP, cents in EUR).
schemestring
Bank payment scheme to process the outbound payment. Currently only "faster_payments" (GBP) is supported.
faster_paymentsreferencestring | null
An optional reference for the outbound payment.
verification_resultstring | null
The result of bank account holder verification, if performed.
full_matchpartial_matchno_matchunable_to_matchvalidation_errorsobject | null
Per-field validation errors for this entry, keyed by resource type and then by field name.
1 properties
outbound_paymentobject
Validation errors for the outbound payment fields.
4 properties
amountarray
Errors related to the amount field.
schemestring
Bank payment scheme to process the outbound payment. Currently only "faster_payments" (GBP) is supported.
faster_paymentsrecipient_bank_accountarray
Errors related to the recipient bank account.
referencearray
Errors related to the reference field.
linksobject
3 properties
outbound_payment_importstring
ID of the associated import.
outbound_paymentstring | null
ID of the associated outbound payment, once the entry has been processed.
recipient_bank_accountstring | null
ID of the recipient bank account.
metadataobject | null
Key-value store of custom data. Up to 3 keys are permitted, with key names up to 50 characters and values up to 500 characters.
metaobject2 properties
limitintegerrequiredcursorsobjectrequired
2 properties
beforestring | nullrequired
Cursor pointing to the end of the desired set.
afterstring | nullrequired
Cursor pointing to the start of the desired set.
Errors 400401404422500
Bad Request
Unauthorised
Not found
Validation Error
Internal Error
Error Body
errorobjectrequiredGeneric error
6 properties
codeintegerdocumentation_urlstringerrorsarrayrequired
6 properties
reasonstringfieldstringrequest_pointerstringmessagestringrequiredmetadataobjectlinksobjectmessagestringrequiredrequest_idstringrequiredtypestring