GoCardless API API Documentation
Submit a Payer Authorisation
POST {{url}}/payer_authorisations/{{payer_authorisation}}/actions/submit
Payer Authorisations is deprecated in favour of Billing Requests. Please consider using Billing Requests to build any future integrations. Submits all the data previously pushed to this PayerAuthorisation for verification. This time, a 200 HTTP status is returned if the resource is valid and a 422 error response in case of validation errors. After it is successfully submitted, the Payer Authorisation can no longer be edited.
Body
PARAM
| Key | Datatype | Required | Description |
HEADERS
| Key | Datatype | Required | Description |
RESPONSES
status OK
| {
"payer_authorisations": {
"id": "PAU00002XASYBMX",
"created_at": "2024-03-22T21:11:54.547Z",
"customer": {
"address_line1": "27 Acer Road",
"address_line2": "Apt 24",
"city": "London",
"country_code": "GB",
"email": "newcustomer@example.com",
"family_name": "Kuphal",
"given_name": "Anya",
"postal_code": "E8 3GX",
"metadata": {
"salesforce_id": "EFGH5678"
}
},
"bank_account": {
"account_holder_name": "Frank Osborne",
"account_number_ending": "11",
"country_code": "GB",
"bank_name": "BARCLAYS BANK PLC",
"metadata": {}
},
"mandate": {
"scheme": "bacs",
"metadata": {
"contract": "ABCD1234"
}
},
"status": "submitted",
"incomplete_fields": [],
"links": {}
}
} |
Curl
curl -X POST 'https://api-sandbox.gocardless.com/payer_authorisations/https://api-sandbox.gocardless.com/actions/submit'
ENDPOINTS