Payment Request

Generate a new payment request

post

Create a new payment request with a specified amount, redirecting to the given url

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Body

amountstringOptionalExample: 100

redirect_urlstringOptionalExample: https://example.com/redirect

reference_idstringOptionalExample: 1234567890

Responses

200

OK

application/json

idstringOptional

redirect_urlstringOptional

reference_idstringOptional

statusstringOptional

urlstringOptional

400

Bad Request

application/json

422

Unprocessable Entity

application/json

post/payments/request

POST /payments/request HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 90

{
  "amount": "100",
  "redirect_url": "https://example.com/redirect",
  "reference_id": "1234567890"
}

{
  "id": "text",
  "redirect_url": "text",
  "reference_id": "text",
  "status": "text",
  "url": "text"
}

Retrieve a payment request by id

get

Retrieves a payment request, together with its current status

Required scopes

This endpoint requires the following scopes:

Authorizations

OAuth2clientCredentialsRequired

Token URL:

Path parameters

idstringRequired

ID of the payment request

Responses

200

OK

application/json

idstringOptional

redirect_urlstringOptional

reference_idstringOptional

statusstringOptional

urlstringOptional

400

Bad Request

application/json

404

Not Found

application/json

get/payments/request/{id}

GET /payments/request/{id} HTTP/1.1
Host: public-api.alternativepayments.io
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

{
  "id": "text",
  "redirect_url": "text",
  "reference_id": "text",
  "status": "text",
  "url": "text"
}