POST Payment

post

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

The endpoints allows you to submit a payment creation request. In your request you must include debtor, creditor, FX trade reference (if applicable), existing beneficiary details or Beneficiary ID (new beneficiary) in the parameters. A successful response will return the created payment 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…

Body Params

PaymentDate

date

required

length ≥ 1

PaymentDate in YYYY-MM-DD format.

Amount

number

required

Payment amount.

Currency

string

required

length ≥ 1

Currency of the payment.

CreditorAccountId

string | null

Creditor (beneficiary) ID. Required if CreditorAccount is not populated.

Reference

string | null

Payment reference.

TradeReference

string | null

Trade reference.

DebtorAccountId

string | null

DebtorAccountId. Either DebtorAccountId or DebtorAccountIban must be provided.

DebtorAccountIban

string | null

DebtorAccountIban. Either DebtorAccountId or DebtorAccountIban must be provided.

Purpose

string | null

Purpose of the payment.

VerificationId

string | null

Verification ID is only required for European entities making payments within the EU. To obtain the Verification ID, please verify the payee name using the payment verification endpoint.

CreditorAccount

Creditor (beneficiary) account details. Required if creditor account ID is not provided.

Headers

Idempotency-Key

string | null

Optionally provide an idempotency key header. If an idempotency key is present and this is a duplicate request, a 409 status will be returned. A duplicate request is a request which has the same EntityId/idempotency-key pair as another recent request.

Responses

401

Unauthorized.

403

Forbidden.

404

Resource not found.

409

Matching idempotency key within 24 hours.

Language

Credentials

OAuth2

Loading…

Response

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

application/json

201Request created successfully.

400There were errors in the request.

500Internal server error.