GOgocardless
Payment

Create a payment

<a name="mandate_is_inactive"></a>Creates a new payment object.

This fails with a mandate_is_inactive error if the linked mandate is cancelled or has failed. Payments can be created against mandates with status of: pending_customer_approval, pending_submission, submitted, and active.

<p class="notice--warning"><strong>Warning</strong>: in Bacs, you have the option to provide a payment reference up to 10 characters in length. However, if you are providing custom mandate references (which can only be enabled by contacting support), the combined length of the two references separated by a dash character must not exceed 18 characters. Payment references may be up to 140 characters for SEPA, 11 for Autogiro and 30 for Betalingsservice, irrespective of the mandate reference.</p>
post/payments

Request

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

Headers

GoCardless-Versionstring required

Request body

Example request

{
  "payments": {
    "currency": "EUR",
    "description": "One-off upgrade fee",
    "charge_date": "2014-05-21",
    "reference": "WINEBOX001",
    "links": {
      "mandate": "MD123"
    }
  }
}

Response

Resource created successfully

Example response

{
  "payments": {
    "id": "PM123",
    "created_at": "2014-01-01T12:00:00.000Z",
    "amount": 1000,
    "amount_refunded": 150,
    "currency": "EUR",
    "description": "One-off upgrade fee",
    "charge_date": "2014-05-21",
    "reference": "WINEBOX001",
    "status": "submitted",
    "app_fee": 100,
    "links": {
      "mandate": "MD123",
      "creditor": "CR123",
      "payout": "PO123",
      "subscription": "SU123",
      "instalment_schedule": "IS123"
    },
    "fx": {
      "exchange_rate": "1.1234567890",
      "estimated_exchange_rate": "1.1234567890",
      "fx_currency": "EUR"
    },
    "scheme": "bacs"
  }
}

Changes

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