The adyen payment object
A comprehensive list of the adyen payment resource's attributes and relationships
An adyen payment object is returned as part of the response body of each successful list, retrieve, create or update API call to the /api/adyen_payments
endpoint.
Fields
type
string
adyen_payments
id
string
The adyen payment unique identifier
links.self
string
The adyen payment endpoint URL
attributes.public_key
string
The public key linked to your API credential.
attributes.payment_methods
object
The merchant available payment methods for the assoiated order (i.e. country and amount). Required by the Adyen JS SDK.
attributes.payment_request_data
object
The Adyen payment request data, collected by client.
attributes.payment_request_details
object
The Adyen additional details request data, collected by client.
attributes.payment_response
object
The Adyen payment response, used by client (includes 'resultCode' and 'action').
attributes.mismatched_amounts
boolean
Indicates if the order current amount differs form the one of the associated authorization.
attributes._details
boolean
Send this attribute if you want to send additional details the payment request.
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
)
Last updated