GOgocardless
Outbound Payment Import

Create an outbound payment import

post/outbound_payment_imports

Request

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

Headers

GoCardless-Versionstring required

Request body

Example request

{
  "outbound_payment_imports": {
    "entry_items": [
      {
        "scheme": "faster_payments",
        "amount": 1000,
        "recipient_bank_account_id": "BA123",
        "reference": "GC-QC2FI7GBEW7VCXL"
      }
    ],
    "links": {
      "creditor": "CR123"
    }
  }
}

Response

Resource created successfully

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"
    }
  }
}

Changes

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