Collect Payment

Collect a payment for an agreement

POST /v3/customers/me/agreements/{agreementId}/transactions/payment

Request

The details below help you form your HTTP requests to this endpoint.

Headers

You may need to provide specific headers.

Name	Type	Required	Description
customer-token	string		Customer's authentication token
x-version-override	string		N/A

Path Parameters

The endpoint path expects parameters.

Name	Type	Required	Description
agreementId	string		Agreement Id

Body

You must provide a JSON payload.

Name	Type	Required	Description
paymentMethodId	string		Payment Method Id
amount	number		Amount

Response

The details below help you understand the responses you could get from this endpoint.

Samples

Below are samples of responses, with tabs corresponding to returned status code.

200

[
    {
        "paymentId": "682799b08737e7663dc31f32",
        "amount": 2,
        "failureReason": "DECLINE CHECK CHECK LIMIT EXCEEDED",
        "failureCode": "123"
    }
]

Schema

The response's schema is outlined below.

Name	Type	Required	Description
data	array		N/A
data[].paymentId	string		Payment ID
data[].amount	number		Amount
data[].outcome	string		Outcome
data[].failureReason	string		Failure Reason
data[].failureCode	string		Failure Code