Authorise Payment - Currencycloud API Documentation

Home > Pay > Payments > Authorise Payment

/v2/payments/authorise

POST

Authorises a payment pending authorisation.

The API responses shown below are static. If you want to try out the API please login, or register for an API key

API parameters

Required

Name	In	Type	Description	Items
X-Auth-Token	header	string	Authentication token.
payment_ids[]	query	array	One or more payment UUID identifiers to be authorised.	string

curl -X POST  --header "X-Auth-Token: XXXX-XXXXX-XXXX"  https://devapi.currencycloud.com/v2/payments/authorise

Response

{
    "authorisations": [
        {
            "payment_id": "1c19d453-5249-4f1a-ae4d-19f0debf6197",
            "payment_status": "awaiting_authorisation",
            "updated": true,
            "error": null,
            "auth_steps_taken": 1,
            "auth_steps_required": 2,
            "short_reference": "180628-FGVXPX001"
        }
    ]
}

Error Codes

HTTP Status	Code	Description
400	payment_ids_is_required	payment_ids is required
	payment_ids_type_is_wrong	payment_ids should be of array type
	on_behalf_of_self	You cannot act on behalf of your own Contact
401	invalid_supplied_credentials	Authentication failed with the supplied credentials
429	too_many_requests	Too many requests have been made to the api. Please refer to the Developer Center for more information
500	internal_server_error	Internal server error
503	service_unavailable	Service is temporary unavailable

Was this page helpful?

Yes