WePay logo
      Nothing Found

Update an adjustment

post/adjustments/{id}

The POST /adjustments/{id} call allows your platform to update and add custom data to an adjustment. The adjustments resource notifies your platform that WePay made an adjustment to an account.

SecurityappIdAuth and appTokenAuth
Request
path Parameters
id
required
string [ 1 .. 255 ] characters

ID of the adjustment, generated by WePay when the adjustment is created.

header Parameters
Api-Version
required
string
Example: 3.0
Content-Type
required
stringapplication/json
Example: application/json
Unique-Key
string
Request Body schema: application/json
object or null

Any custom data your platform chooses to attach to this resource. The custom data must be key-value pairs and not contain any personally identifiable information (PII) or payment card (PCI) data.

Array of objects or null

Any rbit data your platform chooses to attach to this resource. The rbit data must be key-value pairs and can be an array of rbit objects.

Responses
200
Response Schema: application/json
required
object or null

When an adjustment occurs, fetch this transaction record to account for the credit OR debit impacting the merchant's account balance.

resource
required
string

Helps organize information by identifying the resource type of the object data.

Value: Description
adjustments
required
object or null

Any custom data your platform chooses to attach to this resource. The custom data must be key-value pairs and not contain any personally identifiable information (PII) or payment card (PCI) data.

required
object

Reasons for and details about the Adjustment.

currency
required
string

ISO 4217 currency code. Possible values include: CAD, GBP, USD.

amount
required
integer

Amount of the adjustment.

create_time
required
integer <int64> >= 0

The time (in UNIX) when the adjustment was created.

required
object or null

Details the owner resource and owner path.

path
required
string

Path of resource and resource ID.

type
required
string

Types of adjustments. Possible values include: credit, debit.

Enum: Description
credit

Indicates that the adjustment credited the given account with the given amount.

debit

Indicated that the adjustment debited the given account for the given amount.

id
required
string

ID of the adjustment, generated by WePay when the adjustment is created.

api_version
string
400

INVALID_PARAMS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples
application/json
{
  • "custom_data": {
    • "reference_number": 43453
    }
}
Response samples
application/json
{
  • "amount": 1000,
  • "create_time": 1520471380,
  • "currency": "USD",
  • "custom_data": {
    • "reference_number": 43453
    },
  • "id": "b3cfe648-1215-4b04-a856-9021454aeda9",
  • "owner": {
    • "id": "f9cd0a9b-9f61-47df-8eb6-ff1a6177ad01",
    • "path": "/accounts/f9cd0a9b-9f61-47df-8eb6-ff1a6177ad01",
    • "resource": "accounts"
    },
  • "path": "/adjustments/b3cfe648-1215-4b04-a856-9021454aeda9",
  • "reason": {
    • "reason_code": "REIMBURSEMENTS_AND_CORRECTIONS",
    • "reason_message": "Adjustment for reimbursement or corrections.",
    • "details": [
      • {
        • "detail_code": "bank_overdraft_fee",
        • "detail_message": "Reimbursement of Bank Overdraft Fee."
        }
      ]
    },
  • "resource": "adjustments",
  • "txnr_adjustment": {
    • "id": "a7ce1142-e4f7-4790-aa10-dcc151ae1b7b",
    • "path": "/transaction_records/a7ce1142-e4f7-4790-aa10-dcc151ae1b7b",
    • "resource": "transaction_records"
    },
  • "type": "credit",
  • "api_version": "3.0"
}