Create a test fiat-deposit.

POST 
/sandbox/fiat-deposit/simulate

Only available in sandbox environment. A fiat deposit will be created towards a fiat payment method. This could trigger webhooks, worklows or rules that you have previously setup.

Request

Header Parameters

Api-Signature string

Digitally signed JWT.

application/json

Body

required

PaymentMethodID PaymentMethodID (string)required

Existing payment method id to be used.

Possible values: non-empty and <= 150 characters

FiatAmount PositiveDecimal (string)required
The amount of the deposit.
Possible values: non-empty and <= 38 characters, Value must match regular expression ^[+]?([.]\d+|\d+[.]?\d*)$
Example: 10.1
FiatCurrency FiatCurrencyCode (string)required
Supported fiat ISO_4217 3 letter currency codes.
Example: USD

Responses

200

Fiat deposit created successfully

application/json

Schema

Schema

FiatDepositID stringrequired

Example (from schema)

{
  "FiatDepositID": "string"
}

400

Bad request

application/json

Schema

Schema

Type ErrorType (string)
Type of error:
• InvalidMessage
• Unexpected
• ResourceNotFound
• Unauthorized
• Forbidden
• InsufficientBalance
Example: InvalidMessage
Instance string

A unique reference that identifies the specific occurrence of the problem

Action string

Action taking place which resulted in error.

Detail string

Details about the error.

Extensionsobject

Additional information about the error.

Request object

Details about invalid request properties.

Featuresobject

Details about the disabled feature flags

property name*

string[]

List of reasons

Array [

string

]

Example (from schema)

{
  "Type": "InvalidMessage",
  "Instance": "string",
  "Action": "string",
  "Detail": "string",
  "Extensions": {
    "Request": {},
    "Features": {}
  }
}

401

Client is not authorized to perform this action

application/json

Schema

Schema

Type ErrorType (string)
Type of error:
• InvalidMessage
• Unexpected
• ResourceNotFound
• Unauthorized
• Forbidden
• InsufficientBalance
Example: InvalidMessage
Instance string

A unique reference that identifies the specific occurrence of the problem

Action string

Action taking place which resulted in error.

Detail string

Details about the error.

Extensionsobject

Additional information about the error.

Request object

Details about invalid request properties.

Featuresobject

Details about the disabled feature flags

property name*

string[]

List of reasons

Array [

string

]

Example (from schema)

{
  "Type": "InvalidMessage",
  "Instance": "string",
  "Action": "string",
  "Detail": "string",
  "Extensions": {
    "Request": {},
    "Features": {}
  }
}

500

Internal server error

application/json

Schema

Schema

Type ErrorType (string)
Type of error:
• InvalidMessage
• Unexpected
• ResourceNotFound
• Unauthorized
• Forbidden
• InsufficientBalance
Example: InvalidMessage
Instance string

A unique reference that identifies the specific occurrence of the problem

Action string

Action taking place which resulted in error.

Detail string

Details about the error.

Extensionsobject

Additional information about the error.

Request object

Details about invalid request properties.

Featuresobject

Details about the disabled feature flags

property name*

string[]

List of reasons

Array [

string

]

Example (from schema)

{
  "Type": "InvalidMessage",
  "Instance": "string",
  "Action": "string",
  "Detail": "string",
  "Extensions": {
    "Request": {},
    "Features": {}
  }
}

Loading...