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": "edae67d9-6a15-4758-9c7a-992c00de49db",
        "amount": 2949,
        "due_date": "2026-07-03",
        "currency": "TND",
        "metadata": null,
        "allow_post_due_date_deduction": false
    }
}'

Response Example

201 - Example 1

{
    "payment_record": {
        "id": "b7e4f6d5-14e9-4b31-bf2a-0ad7eff5499e",
        "mandate_id": "84209156-f154-4b11-90b0-8d4149af7c51",
        "due_date": "2026-05-04",
        "requested_amount": 2949,
        "currency": "MDL",
        "status": "PendingSubmission",
        "actual_amount": 0,
        "metadata": null,
        "expected_payments": [
            {
                "expected_pay_date": "2027-01-09",
                "amount": 983,
                "supply_method": "Payroll",
                "status": "PendingSubmission"
            },
            {
                "expected_pay_date": "2026-05-11",
                "amount": 983,
                "supply_method": "Payroll",
                "status": "PendingSubmission"
            },
            {
                "expected_pay_date": "2027-01-01",
                "amount": 983,
                "supply_method": "Payroll",
                "status": "PendingSubmission"
            }
        ]
    }
}

Payment Requests

Cancel an existing payment request