Query - Paybyrd

Authorizations

x-api-key

string

header

required

Path Parameters

transactionId

string

required

The transaction identifier generated by Paybyrd.

Response

200 - application/json

200

amount

string

The transaction amount.

Example:

"-1.00"

isoAmount

integer<int64>

The transaction amount.

Example:

-100

brand

string

The transaction brand.

Example:

"MASTER"

code

enum<string>

Represents the Paybyrd code of the web request. To see more details check in Return Codes [blocked] page.

Available options:

BYRD010,

BYRD200,

BYRD201,

BYRD203,

BYRD205,

BYRD206,

BYRD207,

BYRD208,

BYRD230,

BYRD231,

BYRD240,

BYRD290,

BYRD291,

BYRD292,

BYRD294,

BYRD299,

BYRD401,

BYRD403,

BYRD900,

BYRD901,

BYRD999

Example:

"BYRD200"

createdDate

string

Example:

"2021-06-01T01:21:41Z"

currency

string

Example:

"EUR"

description

enum<string>

Represents a textually the description of the Paybyrd code of the web request. To see more details check in Return Codes [blocked] page

Available options:

Request accepted,

Operation successfully completed,

Payment being processed. Waiting for shopper,

An error occurred while processing the payment. Please query the transaction to confirm its status,

Operation rejected,

Operation blocked by velocity,

Pending redirect,

Payment canceled by the shopper,

Payment already refunded,

The refund amount exceeds the remaining balance of the original payment,

Token is expired,

An error occurred while pre processing the transaction. Please review your request and try again,

An error occurred during while preparing transaction for acquiring. Please review your request and try again,

No payment methods available for this operation. Please contact Paybyrd's support,

Transaction could not be updated. Please review your request and try again,

Operation could not be completed. Please review your request and try again,

Resource access is forbidden,

Resource access unauthorized,

Invalid input,

Resource not found,

Operation failed

Example:

"Operation successfully completed"

externalCustomIdentifier

string

Example:

"33ff7bd9-1d6e-4bd0-bc2d-a4aef8614972"

externalSessionIdentifier

string

Example:

"bda69b31-8a81-4779-801e-f7d6e5d3fa47"

externalTransactionIdentifier

string

Example:

"dc3f1e75-0e4b-49c5-a68e-5adea241e749"

index

integer

default:0

This value represents the transaction order in the timeline of the transaction.

Example:

4

initiatedFrom

string

Defines where the transaction was started from.

Example:

"Server"

operationType

string

Identifies what a kind of transaction is it.

Example:

"Refund"

personId

integer

default:0

Identify which merchant is the transaction owner.

Example:

10

referencedTransactions

object[]

Show child attributes

status

string

Example:

"Success"

subscriptionGuid

string

Example:

"5b16391d-b8b8-45c9-8aa3-4f6f3ce5a656"

transactionDate

string

Example:

"2021-06-01T01:21:41Z"

transactionId

string

Example:

"33ff7bd9-1d6e-4bd0-bc2d-a4aef8614972"

fingerPrint

string

This field represents the shopper FingerPrint in the Paybyrd's systems.

Example:

"V0010015818248598768349855188"

acquirerResponseCode

string

The authorization host response code.

Example:

"00-I"

acquirerResponseMessage

string

The authorization host response message

Example:

"Authorized"

acquirerEntity

string

The acquirer entity

Example:

11854

acquirerReference

string

The acquirer reference

Example:

999999935

multicaixaExpress

object

Multicaixa Express payment details. Only present when the transaction brand is MULTICAIXAEXPRESS.

Show child attributes