GET Payments (RM Only)

get

https://sandbox.api.alphagroup.com/v1/payments

The endpoint allows you to retrieve payment details for a submitted payment. The Payment id is a required parameter. A successful response will return the payment details including creditor and beneficiary details. In the event of an error, a failure response will be returned with problem details.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

EntityId

string

required

Entity ID.

Status

array of objects | null

Payment Statuses

Status

Allowed:

Currency

string | null

Currency code ISO 4217.

Country

string | null

Country code ISO 3166 of the beneficiaries bank.

FromValueDate

date-time | null

From (value date).
A UTC ISO 8601 date in YYYY-MM-DD format.
Only the date will be used. If a time is provided it will be ignored.

ToValueDate

date-time | null

To (value date).
A UTC ISO 8601 date in YYYY-MM-DD format.
Only the date will be used. If a time is provided it will be ignored.

FromOrderDate

date-time | null

From (order date).
A UTC ISO 8601 date in YYYY-MM-DD format.
Only the date will be used. If a time is provided it will be ignored.

ToOrderDate

date-time | null

To (order date).
A UTC ISO 8601 date in YYYY-MM-DD format.
Only the date will be used. If a time is provided it will be ignored.

SearchText

string | null

Free text used to search the payment reference, beneficiary name, or contract number.

BeneficiaryId

string | null

Beneficiary ID.

PageNumber

int32

1 to 2147483647

Page number.

PageSize

int32 | null

Results page size

Responses

401

Unauthorized.

403

Forbidden.

404

Resource not found.

Language

Credentials

OAuth2

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Payments response.

400There were errors in the request.

500Internal server error.