GOgocardless
Outbound Payment Import

List outbound payment imports

Returns a cursor-paginated list of your outbound payment imports.

get/outbound_payment_imports

Request

  • Base URL
    https://api.gocardless.com
  • Auth
    HTTP bearer

Query parameters

beforestring nullable

Cursor pointing to the end of the desired set.

afterstring nullable

Cursor pointing to the start of the desired set.

integer
OR
string

Number of records to return.

gtstring date-time

Limit to records created after the specified date-time.

ltstring date-time

Limit to records created before the specified date-time.

gtestring date-time

Limit to records created on or after the specified date-time.

ltestring date-time

Limit to records created on or before the specified date-time.

status'created' | 'validating' | 'valid' | 'invalid' | 'processing' | 'processed' | 'cancelled'

The status of the outbound payment import.

  • created: The initial state of a new import.
  • validating: Import validation in progress.
  • invalid: Import validation failed.
  • valid: Import validation succeeded.
  • processing: Authorisation received; payments are being generated.
  • processed: All entries have been successfully converted into outbound payments.
  • cancelled: The import was cancelled by a user or automatically expired by the system.
Example:created

Headers

GoCardless-Versionstring required

Response

Successful response

Example response

{
  "outbound_payment_imports": [
    {
      "id": "IM123",
      "created_at": "2014-01-01T12:00:00.000Z",
      "status": "created",
      "amount_sum": 1000,
      "currency": "GBP",
      "authorisation_url": "https://manage.gocardless.com/imports/IM123",
      "entry_counts": {
        "total": 1000,
        "valid": 1000,
        "processed": 1000
      },
      "links": {
        "creditor": "CR123"
      }
    }
  ],
  "meta": {
    "limit": 50
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.