GRgriffin
Payments

Submit payment

Changed on

Submits a previously created payment for execution.

You can submit payments over different payment schemes, check out our payments guides to help decide which scheme best suites your use case.

post/v0/payments/{payment-id}/submissions

Request

Path parameters

payment-idstring required

Request body

payment-scheme'fps' | 'book-transfer' required

Specifies the scheme over which a payment is executed.

Response

OK

submission-status'scheduled' | 'failed' | 'processing' | 'returned' | 'delivered' required

Specifies the progress of the outbound payment.

created-by-urlstring

Link to the user.

scheduled-atstring date-time

ISO 8601 formatted date-time.

created-atstring date-time required

ISO 8601 formatted date-time.

submission-status-reasonstring
payment-urlstring required

Link to the payment resource.

unique-scheme-identifierstring
submission-urlstring required

Example response

{
  "created-by-url": "/v0/users/ur.ICAgICAgICAgdXNlci1pZA",
  "payment-url": "/v0/payments/pm.ICAgICAgcGF5bWVudC1pZA",
  "unique-scheme-identifier": "PGIT2IS7AJG77D2HK23020240212826NatWes     ",
  "submission-url": "/v0/submissions/ps.ICAgc3VibWlzc2lvbi1pZA"
}

Changes