GuidesAPI ReferenceChangelog
Log In
API Reference

Create a mock payment for a payment method

post
https://sandbox.xfers.io/api/v4/payment_methods///tasks

[Available in Sandbox environment only] Simulate a payment to a payment method. Note that payments captured by static payment methods cannot be cancelled.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
ActionDescription
receive_payment
  • *[Sandbox only]** Simulates a payment received from the customer for a given payment. Status will be changed to paid.
Path Params
string
required

The type of payment method. Input either "virtual_bank_accounts" or "paynow".

string
required

Payment Method ID

Body Params
string

The task action to be performed. In this case, as we are simulating a payment being received by a given Payment Method, this value should be set as "receive_payment".

options
object

These are options you can set for the payment simulation. You can set the amount to be received for now.

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?