Update a transaction - WooshPay OpenAPI

Request

Authorization

Send your HTTP requests with an

Authorization

header that contains the word Basic followed by a space and a base64-encoded string {{Username}}:{{Password}}

Example:

Authorization: Basic YWRtaW46MTIzNDU2

Path Params

string

required

Header Params

string

required

Default:

application/json

Content-Type

string

required

Default:

application/json

Body Params application/json

metadata

string

optional

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

Example

{
  "metadata": "string"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Body

string

optional

Unique identifier for the object.

object

string

optional

String representing the object’s type. Objects of the same type share the same value.

amount

integer

optional

The transaction amount

authorization

string

optional

The Authorization object that led to this transaction.

card

string

optional

The card used to make this transaction.

cardholder

string

optional

The cardholder to whom this transaction belongs.

currency

string

optional

Three-letter ISO currency code, in lowercase. Must be a supported currency.

metadata

object

optional

Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

type

enum<string>

optional

The nature of the transaction.

Allowed values:

capturerefund

created

string

optional

Time at which the object was created. Measured in seconds since the Unix epoch.

dispute

string

optional

If you’ve disputed the transaction, the ID of the dispute.

livemode

boolean

optional

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

merchant_amount

integer

optional

The amount that the merchant will receive, denominated in merchant_currency and in the smallest currency unit. It will be different from amount if the merchant is taking payment in a different currency.

merchant_currency

string

optional

The currency with which the merchant is taking payment.

merchant_data

object

optional

Details about the seller (grocery store, e-commerce website, etc.) involved in this transaction.

category

string

optional

A categorization of the seller’s type of business.

category_code

string

optional

The merchant category code for the seller’s business

city

string

optional

City where the seller is located

country

string

optional

Country where the seller is located

name

string

optional

Name of the seller

network_id

string

optional

Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant.

postal_code

string

optional

Postal code where the seller is located

state

string

optional

State where the seller is located

terminal_id

string

optional

An ID assigned by the seller to the location of the sale.

url

string

optional

URL provided by the merchant on a 3DS request

network_data

object

optional

Details about the transaction, such as processing dates, set by the card network.

transaction_id

string

optional

The transaction ID from VISA network

Example

{
  "id": "string",
  "object": "string",
  "amount": 0,
  "authorization": "string",
  "card": "string",
  "cardholder": "string",
  "currency": "string",
  "metadata": {},
  "type": "capture",
  "created": "string",
  "dispute": "string",
  "livemode": true,
  "merchant_amount": 0,
  "merchant_currency": "string",
  "merchant_data": {
    "category": "string",
    "category_code": "string",
    "city": "string",
    "country": "string",
    "name": "string",
    "network_id": "string",
    "postal_code": "string",
    "state": "string",
    "terminal_id": "string",
    "url": "string"
  },
  "network_data": {
    "transaction_id": "string"
  }
}