Payments / Status

Payments / Status

Name

Status

Description

Gives a query-able list of payments for a brokerages.

Type

GET

URL

/v9/payments/status

Long Description

Gives a query-able list of payments for a brokerages. All payments are scoped to the office that the POS user is assigned to. Currently, this endpoint is only supported by the POS.

Parameters

Name

Description

Value Type

Required

Name

Description

Value Type

Required

order_type

Type of order (e.g. purchase_order, order, or all)

String

Optional

transaction_type

Type of Transaction (e.g. EvopayTransaction, CreditCardTransaction)

String

Optional

seller_id

ID of the seller

Integer

Optional

seller_type

Type of the seller (e.g. Office, Client)

String

Optional

seller_name

Name of the seller (e.g. Gold, John)

String

Optional

buyer_id

ID of the buyer

String

Optional

buyer_type

Type of the buyer (e.g. Office, Client)

String

Optional

buyer_name

Name of the seller (e.g. Ace, Alice)

String

Optional

transaction_state

State of the transaction (e.g. completed, pending)

String

Optional

created_at

The ISO-8601 date (e.g. 2013-01-01) for when the payment was created.
 Can also be refined with a range (e.g. created_at.[ gt | gte | lt | lte])

String

Optional

updated_at

The ISO-8601 date (e.g. 2013-01-01) for when the payment was last updated.
 Can also be refined with a range (e.g. updated_at.[ gt | gte | lt | lte])

String

Optional

 

Examples

Request

Response

Request

Response

/v9/payments/status?buyer_type=Office&created_at.gte=2013-04-04&order_type=all

 

None...
{ "payments":[ { "created_at":"2013-04-04T01:53:40Z", "buyer_name":"Ticket Evolution", "seller_name":"Ticket King - WI", "updated_at":"2013-04-04T01:53:40Z", "is_refund":false, "transaction_type":"EvopayTransaction", "transaction_amount":"128.0", "order_group_id":22483, "id":30496, "buyer_id":6, "payment_amount":"128.0", "order_link_id":96060, "seller_id":116, "seller_type":"Office", "buyer_type":"Office", "transaction_state":"pending" }, { "created_at":"2013-04-04T01:23:26Z", "buyer_name":"SeatGeek", "seller_name":"Ticket Evolution", "updated_at":"2013-04-04T01:23:26Z", "is_refund":false, "transaction_type":"EvopayTransaction", "transaction_amount":"100.0", "order_group_id":22458, "id":30459, "buyer_id":1116, "payment_amount":"100.0", "order_link_id":96017, "seller_id":6, "seller_type":"Office", "buyer_type":"Office", "transaction_state":"pending" }, { "created_at":"2013-04-04T09:42:31Z", "buyer_name":"Ticket Evolution", "seller_name":"Stagefront Tickets", "updated_at":"2013-04-04T09:42:31Z", "is_refund":false, "transaction_type":"EvopayTransaction", "transaction_amount":"48.0", "order_group_id":22541, "id":30578, "buyer_id":6, "payment_amount":"48.0", "order_link_id":96198, "seller_id":1036, "seller_type":"Office", "buyer_type":"Office", "transaction_state":"pending" } ] }