Instruct a new payment request

Developing

Cloud Mock

https://mock.apidog.com/m1/828215-0-default

POST

/payments

OperationId:create_new_payment_request

Create a new payment request. Ontime will attempt to satisfy the payment request following the next available employee pay date. Payments are not automatically re-occuring.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

OAuth 2.0

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Token URL: https://{domain}.auth.{region}.amazoncognito.com

Scopes:

payments:write-Create and cancel payment requests.

Header Params

Body Params application/json

Examples

Responses

🟢201Created

application/json

Body

🟠422Parameter Error

🟠403Forbidden

🟠409Conflict

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://mock.apidog.com/m1/828215-0-default/payments' \
--header 'Idempotency-Key: {{$string.uuid}}' \
--header 'x-api-key: <api-key>' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "payment_record": {
        "mandate_id": "67e73e76-a13c-4817-9474-330e58864c27",
        "amount": 43455,
        "due_date": "2026-03-18T07:40:25.021Z",
        "currency": "BHD",
        "metadata": null
    }
}'

Response Example

201 - Example 1

{
    "payment_record": {
        "id": "69385c01-872b-41c9-a298-dd4c46715ed5",
        "mandate_id": "dad4b0a1-8f01-4317-b12b-4c872b398f54",
        "due_date": "2025-08-11T14:50:32.364Z",
        "requested_amount": 36338,
        "currency": "IDR",
        "expected_pay_date": "2025-08-04T14:50:32.367Z",
        "status": "Cancelled",
        "actual_amount": 31215,
        "metadata": null
    }
}

Payment Requests

Cancel an existing payment request