GOgocardless
Payout

Update a payout

Updates a payout object. This accepts only the metadata parameter.

put/payouts/{payout_id}

Request

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

Path parameters

payout_idstring required

The payout id

Headers

GoCardless-Versionstring required

Request body

Response

Successful response

Example response

{
  "payouts": {
    "id": "PO123",
    "created_at": "2014-01-01T12:00:00.000Z",
    "amount": 1000,
    "deducted_fees": 20,
    "currency": "EUR",
    "reference": "ref-1",
    "status": "pending",
    "payout_type": "merchant",
    "arrival_date": "2014-01-01",
    "links": {
      "creditor": "CR123",
      "creditor_bank_account": "BA123"
    },
    "fx": {
      "exchange_rate": "1.1234567890",
      "estimated_exchange_rate": "1.1234567890",
      "fx_currency": "EUR"
    },
    "tax_currency": "EUR",
    "metadata": {
      "salesforce_id": "ABCD1234"
    }
  }
}

Changes

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