The axerve payment object

A comprehensive list of the axerve payment resource's attributes and relationships

An axerve payment object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/axerve_payments endpoint.
Fields
Field
Type
Description
type
string
axerve_payments
id
string
The axerve payment unique identifier
links.self
string
The axerve payment endpoint URL
attributes.login
string
The merchant login code.
attributes.return_url
string
The URL where the payer is redirected after they approve the payment.
attributes.payment_request_data
object
The Axerve payment request data, collected by client.
attributes.mismatched_amounts
boolean
Indicates if the order current amount differs form the one of the associated authorization.
attributes.intent_amount_cents
integer
The amount of the associated payment intent, in cents.
attributes.intent_amount_float
float
The amount of the associated payment intent, float.
attributes.formatted_intent_amount
string
The amount of the associated payment intent, formatted.
attributes._update
boolean
Send this attribute if you want to update the payment with fresh order data.
attributes.payment_instrument
object
Information about the payment instrument used in the transaction
attributes.created_at
datetime
Time at which the resource was created.
attributes.updated_at
datetime
Time at which the resource was last updated.
attributes.reference
string
A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
attributes.reference_origin
string
Any identifier of the third party system that defines the reference code
attributes.metadata
object
Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
relationships.order
object
The order associated to the adyen payment, that is set as its payment source.
relationships.payment_gateway
object
The associated payment gateway, inherited by the order payment_method.
relationships.versions
array
The associated changes.
meta.mode
string
The resource environment (can be one of test or live)

Field	Type	Description
type	`string`	`axerve_payments`
id	`string`	The axerve payment unique identifier
links.self	`string`	The axerve payment endpoint URL
attributes.login	`string`	The merchant login code.
attributes.return_url	`string`	The URL where the payer is redirected after they approve the payment.
attributes.payment_request_data	`object`	The Axerve payment request data, collected by client.
attributes.mismatched_amounts	`boolean`	Indicates if the order current amount differs form the one of the associated authorization.
attributes.intent_amount_cents	`integer`	The amount of the associated payment intent, in cents.
attributes.intent_amount_float	`float`	The amount of the associated payment intent, float.
attributes.formatted_intent_amount	`string`	The amount of the associated payment intent, formatted.
attributes._update	`boolean`	Send this attribute if you want to update the payment with fresh order data.
attributes.payment_instrument	`object`	Information about the payment instrument used in the transaction
attributes.created_at	`datetime`	Time at which the resource was created.
attributes.updated_at	`datetime`	Time at which the resource was last updated.
attributes.reference	`string`	A string that you can use to add any external identifier to the resource. This can be useful for integrating the resource to an external system, like an ERP, a marketing tool, a CRM, or whatever.
attributes.reference_origin	`string`	Any identifier of the third party system that defines the reference code
attributes.metadata	`object`	Set of key-value pairs that you can attach to the resource. This can be useful for storing additional information about the resource in a structured format.
relationships.order	`object`	The order associated to the adyen payment, that is set as its payment source.
relationships.payment_gateway	`object`	The associated payment gateway, inherited by the order payment_method.
relationships.versions	`array`	The associated changes.
meta.mode	`string`	The resource environment (can be one of `test` or `live`)

Axerve payments

Create an axerve payment

Last modified 29d ago