GuidesAPI ReferenceChangelog
Log In
API Reference

Update a payment

post
https://sandbox-id.xfers.com/api/v4/payments//tasks

Update a payment's status to cancel it or simulate customer payments.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
ActionDescription
cancel
  • *[Dynamic VA only]** Cancel a payment when it is still in pending state. Status will be changed to cancelled.
receive_payment
  • *[Sandbox only]** Simulates a payment received from the customer for a given payment. Status will be changed to paid.
settle
  • *[Sandbox only]** Simulates funds for a payment being made available for transfer or withdrawal. Status will be changed to completed.
Path Params
string
required

The unique identifier id of the payment you are trying to manage.

Query Params
string
required

Action to be performed on the payment. See the list below for the methods you can use to manage a payment's life cycle.

Response

Updated 8 months ago

Did this page help you?
Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago

Did this page help you?