---
title: "Create an outbound payment import"
method: POST
path: "/outbound_payment_imports"
tags: ["Outbound Payment Import"]
---

# Create an outbound payment import

`POST /outbound_payment_imports`

## Request

- Base URL: `https://api.gocardless.com`
- URL: `https://api.gocardless.com/outbound_payment_imports`
- Auth: HTTP bearer

## Headers

- `GoCardless-Version` string, required

## Request body

- object
  - `outbound_payment_imports` object
    - `entry_items` object[], required
      - `scheme` 'faster_payments', required: Bank payment scheme to process the outbound payment. Currently only "faster_payments" (GBP) is supported.
      - `amount` integer, required: Amount, in the lowest denomination for the currency (e.g. pence in GBP, cents in EUR).
      - `recipient_bank_account_id` string, required: ID of the customer bank account which receives the outbound payment.
      - `reference` string: An optional reference that will appear on your customer's bank statement. The character limit for this reference is dependent on the scheme.<br /> <strong>Faster Payments</strong> - 18 characters, including: "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789 &-./"<br />
      - `metadata` OutboundPaymentImportEntryItemMetadata, nullable: 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.
    - `links` object
      - `creditor` string: ID of the creditor who sends the outbound payments from the import.

## Response `201`

Resource created successfully

- OutboundPaymentImportSingleResourceResponse
  - `outbound_payment_imports` OutboundPaymentImport: Outbound Payment Imports allow you to create multiple payments via a single API call. The Workflow: 1. Create the outbound payment import. 2. Retrieve an authorisation link from the response. 3. Redirect the user to the link to authorise the import. 4. Once the user authorises the import, the individual outbound payments are automatically submitted. Import entries are not processed as actual payments until they are reviewed and authorised in GoCardless Dashboard. Upon approval, a unique outbound payment is generated for every entry in the import. <p class="notice">Outbound Payment Imports are capped at 1000 entries. If you expect to exceed this limit, please create multiple smaller imports.</p>
    - `id` string, required: Unique identifier, beginning with "IM".
    - `created_at` string, date-time: Fixed [timestamp](https://docs.gocardless.com/docs/api-reference/data-conventions#dates-and-times), recording when this resource was created.
    - `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.
    - `amount_sum` integer: The sum of all import entry amounts, in the lowest denomination for the currency (e.g. pence in GBP, cents in EUR).
    - `currency` 'GBP': [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217#Active_codes) currency. Currently only "GBP" is supported.
    - `authorisation_url` string: The link to the GoCardless dashboard to review and authorise the import
    - `entry_counts` OutboundPaymentImportEntryCounts
      - `total` integer: The total number of entries included in the import.
      - `valid` integer: Count of entries that passed validation checks.
      - `invalid` integer: Count of entries that failed validation checks.
      - `processed` integer: Count of entries successfully converted into outbound payments after the import was authorised.
      - `failed_to_process` integer: Count of entries that encountered a terminal error during the outbound payment generation process.
      - `verified` integer: Total count of entries checked against bank account holder verification services (e.g., CoP).
      - `verified_with_full_match` integer: Count of entries where the account holder name was a direct match.
      - `verified_with_partial_match` integer: Count of entries where the account holder name was a close match.
      - `verified_with_no_match` integer: Count of entries where the account holder name did not match the records.
      - `verified_with_unable_to_match` integer: Count of entries where the verification service could not return a definitive result.
    - `links` OutboundPaymentImportLinks
      - `creditor` string: ID of the creditor who sends the outbound payments from the import.

## Other responses

- `400`: Bad Request
- `401`: Unauthorised
- `404`: Not found
- `422`: Validation Error
- `500`: Internal Error

---

[API](https://skmtc.dev/gocardless/apis/gocardless-api.md) - [All operations](https://skmtc.dev/gocardless/apis/gocardless-api/llms.txt) - [OpenAPI document](https://skmtc.dev/gocardless/apis/gocardless-api/revisions/4dd3dae45364?raw)