Getting Started

Introduction

Workflows

ApiKeys
- Create an API Keypost
Workflows
WorkflowExecutions
Scopes

Orchestration

ApiKeys
- Create an API Keypost
Payments
Receivers

Getting Started

Introduction

Workflows

ApiKeys
- Create an API Keypost
Workflows
WorkflowExecutions
Scopes

Orchestration

ApiKeys
- Create an API Keypost
Payments
Receivers

Get Receiver

get http://sandbox-planet-oapi-269696318.eu-central-1.elb.amazonaws.com:8080/api/v1/receivers/{receiverId}

Returns the receiver identified by the provided receiverId parameter.

URL Expired

The URL for this request expired after 30 days.

Path Params

receiverId

string

required

length ≤ 50

The receiver identifier.

Responses

Response body

object

identifier

string

required

length ≤ 50

The receiver identifier.

name

string

required

The name to assign to this receiver.

paymentService

string

required

ADYEN DATATRANS STRIPE

integrationArguments

array of objects

required

length between 1 and 3

Additional arguments that will be used to contact the specific receiver through our integrations system. For example, authentication arguments.

integrationArguments*

object

name

string

length ≤ 50

The name of the integration argument.

value

string

length ≤ 150

The value of the integration argument.

Response body

object

type

uri

A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when dereferenced, it provide human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be "about:blank".

title

string

A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation; see [RFC7231], Section 3.4).

status

integer

The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem. Optional field.

detail

string

A human-readable explanation specific to this occurrence of the problem.

errors

array of objects | null

A collection of all errors that occurred when processing the request.

errors

object

code

string | null

The unique error code.

message

string

A human-readable message that states the error.

Response body

object

type

uri

title

string

status

integer

The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem. Optional field.

detail

string

A human-readable explanation specific to this occurrence of the problem.

errors

array of objects | null

A collection of all errors that occurred when processing the request.

errors

object

code

string | null

The unique error code.

message

string

A human-readable message that states the error.

Headers

object

WWW_Authenticate

string

Response body

object

type

uri

title

string

status

integer

The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem. Optional field.

detail

string

A human-readable explanation specific to this occurrence of the problem.

errors

array of objects | null

A collection of all errors that occurred when processing the request.

errors

object

code

string | null

The unique error code.

message

string

A human-readable message that states the error.

Response body

object

type

uri

title

string

status

integer

The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem. Optional field.

detail

string

A human-readable explanation specific to this occurrence of the problem.

errors

array of objects | null

A collection of all errors that occurred when processing the request.

errors

object

code

string | null

The unique error code.

message

string

A human-readable message that states the error.

Response body

object

type

uri

title

string

status

integer

The HTTP status code ([RFC7231], Section 6) generated by the origin server for this occurrence of the problem. Optional field.

detail

string

A human-readable explanation specific to this occurrence of the problem.

errors

array of objects | null

A collection of all errors that occurred when processing the request.

errors

object

code

string | null

The unique error code.

message

string

A human-readable message that states the error.

Updated almost 2 years ago

Get Receivers

Update Receiver

Did this page help you?

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url http://sandbox-planet-oapi-269696318.eu-central-1.elb.amazonaws.com:8080/api/v1/receivers/receiverId \
3
     --header 'accept: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated almost 2 years ago

Get Receivers

Update Receiver

Did this page help you?

Getting Started
Introduction

Workflows
ApiKeys
Create an API Keypost
Workflows
Update a Workflowput
Get a Workflowget
Create a Workflowpost
Conditional Operators
Rules
WorkflowExecutions
Get a Workflow Executionget
Execute a Workflowpost
Get all Workflow Executionsget
Scopes
Update a Scopeput
Get a Scopeget
Create a Scopepost
Get all Scopesget
Scope Field Data Types

Orchestration
ApiKeys
Create an API Keypost
Payments
Refund Paymentpost
Cancel Paymentpost
Capture Paymentpost
Gets a Payment Transactionget
Authorize Paymentpost
Receivers
Delete Receiverdelete
Update Receiverput
Get Receiverget
Get Receiversget
Register Receiverpost

Getting Started
Introduction

Workflows
ApiKeys
Create an API Keypost
Workflows
Update a Workflowput
Get a Workflowget
Create a Workflowpost
Conditional Operators
Rules
WorkflowExecutions
Get a Workflow Executionget
Execute a Workflowpost
Get all Workflow Executionsget
Scopes
Update a Scopeput
Get a Scopeget
Create a Scopepost
Get all Scopesget
Scope Field Data Types

Orchestration
ApiKeys
Create an API Keypost
Payments
Refund Paymentpost
Cancel Paymentpost
Capture Paymentpost
Gets a Payment Transactionget
Authorize Paymentpost
Receivers
Delete Receiverdelete
Update Receiverput
Get Receiverget
Get Receiversget
Register Receiverpost

200The receiver was successfully returned.

400The request is invalid. The specific reason is returned in the response body.

401The requester is not authorized to access the resource.

403The requester is forbidden from accessing the resource.

404The requested resource was not found.

500The request is valid but the server could not process it. The specific reason is returned in the response body.