Skip to main content
POST
/
v1
/
payment-intents
Create or reuse a payment intent
curl --request POST \
  --url http://localhost:3001/v1/payment-intents \
  --header 'Content-Type: application/json' \
  --header 'idempotency-key: <idempotency-key>' \
  --data '
{
  "externalReference": "<string>",
  "sourceAmount": "<string>",
  "sourceCurrency": "<string>",
  "destinationAmount": "<string>",
  "destinationCurrency": "<string>",
  "beneficiaryAccount": "<string>",
  "clientCompletedAt": "2023-11-07T05:31:56Z",
  "beneficiaryName": "<string>",
  "paymentSubtype": "<string>",
  "bridgeTransferId": "<string>",
  "txHash": "<string>",
  "chain": "polygon",
  "stablecoin": "USDC",
  "expectedFxRate": "<string>",
  "developerFeeExpected": "<string>",
  "metadata": {}
}
'
{
  "caseId": "<string>",
  "paymentIntentId": "<string>",
  "externalReference": "<string>",
  "status": "reconciling",
  "verdict": null
}

Headers

​
authorization
string
Minimum string length: 1
​
x-organization-id
string
Minimum string length: 1
​
idempotency-key
string
required
Minimum string length: 1

Body

application/json
​
externalReference
string
required
Minimum string length: 1
​
sourceAmount
string
required
Pattern: ^-?\d+(\.\d+)?$
​
sourceCurrency
string
required
Required string length: 2 - 12
​
destinationAmount
string
required
Pattern: ^-?\d+(\.\d+)?$
​
destinationCurrency
string
required
Required string length: 2 - 12
​
beneficiaryAccount
string
required
Minimum string length: 1
​
clientCompletedAt
string<date-time>
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$
​
statusOnClientSide
enum<string>
required
Available options:
completed,
failed,
reversed
​
beneficiaryName
string
Minimum string length: 1
​
paymentType
enum<string>
Available options:
stablecoin,
bank,
cross_border,
other
​
paymentSubtype
string
Minimum string length: 1
​
bridgeTransferId
string
Minimum string length: 1
​
txHash
string
Minimum string length: 1
​
chain
enum<string>
Available options:
polygon
​
stablecoin
enum<string>
Available options:
USDC
​
expectedFxRate
string
Pattern: ^-?\d+(\.\d+)?$
​
developerFeeExpected
string
Pattern: ^-?\d+(\.\d+)?$
​
metadata
object

Response

Default Response

​
caseId
string
required
​
paymentIntentId
string
required
​
externalReference
string
required
​
status
enum<string>
required
Available options:
reconciling
​
verdict
unknown
required
​
outcome
enum<string>
required
Available options:
created,
reused