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.

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.

Headers
string

application/vnd.api+json

Response

Updated 5 months ago

Language
Credentials
Basic
base64
:
Request
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 5 months ago